Description of Java runtime properties

The next table describes the properties that can be included in the deployment descriptor or program properties file, as well as the source of the value generated into the J2EE environment file, if any. The Java™ type for each property is java.lang.String unless the description column says otherwise.

Runtime property Description Source of the generated value
cso.cicsj2c.timeout Specifies the number of milliseconds before a timeout occurs during a call that uses protocol CICSJ2C. The default value is 30000, which represents 30 seconds. If the value is set to 0, no timeout occurs. The value must be greater than or equal to 0.

The Java type in this case is java.lang.integer.

The cso.cicsj2c.timeout Java runtime property has an effect on calls only when the calling program is deployed to a J2EE environment and the called program is deployed to a CICS® environment. For details, see Setting up the J2EE server for CICSJ2C calls.

cicsj2cTimeout build descriptor option
cso.linkageOptions.LO Specifies the name of a linkage properties file that guides how the generated program or wrapper calls other programs. LO is the name of the linkage options part used at generation. LO is from the linkage build descriptor option; and the default value is the name of the linkage options part followed by the extension .properties.
egl.service.rest.exception.debug Specifies a security value; in particular, whether the exceptions returned by EGL REST-RPC services include the greatest possible level of detail. The property value is true or false.

If the value is false, a runtime exception will return only the following details: a timestamp, a message ID, and a reference to the application server log. The response includes no details about the log's location because those details are specific to one or another kind of application server. In general, the log is the destination for the Java System.err output on the server.

In the development environment, the default value of the property is true.

In the deployed environment, the default value is false. Consider setting the value to true if the details that might be returned are free of security violations, especially if your processing is dependent on the content of error messages.

 
vgj.datemask.gregorian. long.locale Contains the date mask used in either of two cases:
  • The Java code generated for the

    vgVar.currentFormatted
    GregorianDate

    system variable is invoked; or
  • EGL validates a page field or text-form field that has a length of 10 or more, if the dateFormat field property is set to systemGregorianDateFormat.

locale is the code specified in the vgj.nls.code property. You can change the date-mask property in use by calling the sysLib.setLocale function.

The value of this property can either be a date mask, as described in the documentation; or it can be one of the following words:
  • short
  • medium
  • long
These are values found in the Java DateFormat class, and when you use them Java fills in the short, medium, or long format that matches your locale.
vgj.datemask.gregorian. short.locale Contains the date mask used when EGL validates a page field or text-form field that has a length of less than 10, if the dateFormat item property is set to systemGregorianDateFormat.

locale is the code specified in the vgj.nls.code property. In web applications, you may change the date-mask property in use by assigning a different value to sysLib.setLocale.

Build descriptor value for the short Gregorian date mask; the default value is specific to the locale
vgj.datemask.julian.long.locale Contains the date mask used in either of two cases:
  • The Java code generated for the

    vgVar.currentFormatted
    GregorianDate

    system variable is invoked; or
  • EGL validates a page field or text-form field that has a length of 10 or more, if the dateFormat field property is set to systemJulianDateFormat.

locale is the code specified in the vgj.nls.code property. In web applications, you may change the date-mask property in use by assigning a different value to sysLib.setLocale.

The value of this property can either be a date mask, as described in the documentation; or it can be one of the following words:
  • short
  • medium
  • long
These are values found in the Java DateFormat class, and when you use them Java fills in the short, medium, or long format that matches your locale.
vgj.datemask.julian. short.locale Contains the date mask used when EGL validates a page field or text-form field that has a length of less than 10, if the dateFormat item property is set to systemJulianDateFormat.

locale is the code specified in the vgj.nls.code property. In web applications, you may change the date-mask property in use by assigning a different value to sysLib.setLocale.

Build descriptor value for the short Julian date mask; the default value is specific to the locale
vgj.default.databaseDelimiter Specifies the symbol used to separate one value from the next in the sqlLib.loadTable and sqlLib.unLoadTable system functions. The default value is a pipe (|). dbContentSeparator build descriptor option
vgj.default.dateFormat Sets the initial value of the strLib. defaultDateFormat system variable. defaultDateFormat build descriptor option

vgj.default.
I4GLNativeLibrary

Specifies the DLL name accessed by an EGL stereotype NativeLibrary. The property is required if you did not specify the dllName library property.
Note: This is a Java system property. It does not come from usual program properties file or J2EE deployment descriptor.
To set a system property, use the -D option when starting Java. For example:java -Dprop=value where prop is the property name and value is the value you are assigning.
vgj.default.moneyFormat Sets the initial value of the strLib. defaultMoneyFormat system variable. defaultMoneyFormat build descriptor option
vgj.default.numericFormat Sets the initial value of the strLib. defaultNumericFormat system variable. defaultNumericFormat build descriptor option
vgj.default.timeFormat Sets the initial value of the strLib. defaultTimeFormat system variable. defaultTimeFormat build descriptor option
vgj.default.timestampFormat Sets the initial value of the strLib. defaultTimestampFormat system variable. defaultTimestampFormat build descriptor option
vgj.java.command The command used by vgLib.startTransaction to start a new Java Virtual Machine. The default is "java". None
vgj.jdbc.database.SN This is optional. If you make a database connection by using the sysLib.connect or vgLib.connectionService system function, this property specifies the JDBC database name that is used.
The meaning of the value is different for J2EE connections as compared with standard (non-J2EE) connections:
  • In relation to J2EE connections (as is needed in a production environment), the value is the name to which the datasource is bound in the JNDI registry; for example, jdbc/MyDB.
  • In relation to a standard JDBC connection (as may be used for debugging), the value is the connection URL; for example, jdbc:db2:MyDB.

You must customize the name of the property itself when you specify a substitution value for SN, at deployment time. The substitution value in turn must match either the server name that is included in the invocation of vgLib.connectionService or the database name that is included in the invocation of sysLib.connect.

Build descriptor value for the database name that you want to associate with the specified "server name"
vgj.jdbc.default.database Specified the name of the default database. sqlDB or sqlJNDIName build descriptor options
vgj.jdbc.default.database. commitControl Specifies whether a commit occurs after every change to the default database. Valid values are AUTOCOMMIT, NOAUTOCOMMIT, and NOCOMMIT, as described sqlCommitControl. sqlCommitControl build descriptor option
vgj.jdbc.default.database. programName Specifies the default database name that is used for an SQL I/O operation if no prior database connection exists. EGL includes the program name (or program alias, if any) as a substitution value for programName so that each program has its own default database. The program name is optional, however, and a property named vgj.jdbc.default.database is used as a default for any program that is not referenced in a program-specific property of this kind.

The meaning of the value in the property itself is different for J2EE connections as compared with non-J2EE connections:

  • In relation to J2EE connections, the value is the name to which the datasource is bound in the JNDI registry; for example, jdbc/MyDB.
  • In relation to a standard JDBC connection, the value is the connection URL; for example, jdbc:db2:MyDB.
Depends on the connection type:
  • For J2EE connections, the sqlJNDIName build descriptor option
  • For non-J2EE connections, the sqlDB build descriptor option
vgj.jdbc.default.database. password Specifies the password for accessing the database connection identified in vgj.jdbc.default.database. sqlPassword build descriptor option
vgj.jdbc.default.database. userid Specifies the user ID for accessing the database connection identified in vgj.jdbc.default.database. sqlID build descriptor option
vgj.jdbc.drivers Specifies the driver class for accessing the database connection identified in vgj.jdbc.default.database. If there is more than one driver class, separate the class names with semicolons. This property is not present in the deployment descriptor or J2EE environment file and is used only for a standard (non-J2EE) JDBC connection. sqlJDBCDriverClass build descriptor option
vgj.jdbc.pstmt.cache.size Specifies how many prepared statements to keep in the runtime cache.

This property has an effect only for code generated with the following build descriptor option set to YES: cachePreparedStatements.

preparedStatementCacheSize build descriptor option
vgj.messages.file Specifies a properties file that includes messages you create or customize. The file is searched in these cases:
  • The EGL runtime needs to load an error message. In this case, you can use the property to customize EGL's messages.
  • The EGL runtime responds to the invocation of the sysLib.getMessage system function, which returns a message that you created.
  • The EGL runtime is handling a consoleUI application and attempts to present help or comment text from a file identified in the consoleLib. messageResource system variable, but that variable has no value.
userMessageFile build descriptor option
vgj.nls.code Specifies the three-letter NLS code of the program.
If the property is not set, these rules apply:
  • The value defaults to the NLS code that corresponds to the default Java locale.
  • The value is ENU if the default Java locale does not correspond to any of the NLS codes supported by EGL.
  • The NLS code can be changed by calling the sysLib.setLocale system function.
targetNLS build descriptor option
vgj.nls.currency Specifies the character used as a currency symbol. The default is determined by the locale associated with vgj.nls.code. currencySymbol build descriptor option
vgj.nls.currency.location Specifies whether the currency symbol is placed at the front or back of the number, or whether no symbol location is designated. currencyLocation build descriptor option
vgj.nls.number.decimal Specifies the character used as a decimal symbol. The default is determined by the locale associated with vgj.nls.code. decimalSymbol build descriptor option
vgj.nls.number.separator Specifies a symbol for separating the thousands and hundreds in a numeric value. seaparatorSymbol build descriptor option
vgj.ra.FN.fileType Specifies the type of file associated with FN, which is a file identified in the record part. The property value is seqws or mq.

You must specify this deployment descriptor property for each logical file that your program uses.

fileType build descriptor option
vgj.ra.FN.replace Specifies the effect of an add statement on a record associated with FN, which is a file name identified in a record. Select one of two values:
  • 1 if the statement replaces the file record
  • 0 (the default) if the statement appends a record to the file

The Java type in this case is java.lang.integer.

replace resource associations property
vgj.ra.FN.systemName Specifies the name of the physical file or message queue associated with FN, which is a file or queue name identified in the record part.

You must specify this deployment descriptor property for each logical file that your program uses.

systemName resource associations property
vgj.ra.FN.text Specifies whether to cause a generated Java program to do the following when accessing a file by way of a serial record:
  • Append end-of-line characters during the add operation. On non-UNIX platforms, those characters are a carriage return and linefeed; on UNIX platforms, the only character is a linefeed.
  • Remove end-of-line characters during the get next operation.

FN is the file name associated with the serial record.

Select one of these values:
  • 1 for make the changes
  • 0 (the default) for refrain from making the changes

The Java type in this case is java.lang.integer.

text resource associations property
vgj.trace.device.option Destination of trace data, if any. Select one of these values:
  • 0 for write to System.out
  • 1 for write to System.err
  • 2 (the default) for write to the file specified in vgj.trace.device.spec with this exception: for VSAM I/O traces, write to vsam.out

The Java type in this case is java.lang.integer.

The generated value, if any, is 2
vgj.trace.device.spec Specifies the name of the output file if vgj.trace.device.option is set to 2. An exception is that VSAM I/O traces are written to vsam.out The generated value, if any, is vgjtrace.out; this is the default value
vgj.trace.type Specifies the runtime trace setting. Sum the values of interest to get the tracing you want:
  • -1 for trace all
  • 0 for no trace (the default)
  • 1 for general trace, including function invocations and call statements
  • 2 for system functions that handle math
  • 4 for system functions that handle strings
  • 16 for data passed on a call statement
  • 32 for the linkage options used on a call
  • 128 for jdbc I/O
  • 256 for file I/O
  • 512 for all the properties except vgj.jdbc.default.password

The Java type in this case is java.lang.integer.

The generated value, if any, is 0
The following table lists properties from the TCPIPListener program properties file.
Runtime property Description Source of the generated value
tcpiplistener.port

Specifies the number of the port on which an EGL TCP/IP listener (of class TcpipListener or TcpipListenerJ2EE) listens. No default exists. For details, see Setting up a TCP/IP listener for J2EE called applications or Setting up the TCP/IP listener for a called non-J2EE application.

The Java type in this case is Java.lang.Integer.

Not generated
tcpiplistener.trace.file Specifies the name of the file in which to record the activity of one or more EGL TCP/IP listeners (each is of class TcpipListener or TcpipListenerJ2EE). The default file is tcpiplistener.out. Not generated; tracing is only for use by IBM®
tcpiplistener.trace.flag Specifies whether to trace the activity of one or more EGL TCP/IP listeners (each of class TcpipListener or TcpipListenerJ2EE). Select one of these:
  • 1 for recording the activity into the file identified in property tcpiplistener.trace.flag
  • 0 (the default value) for not recording the activity

The Java type in this case is Java.lang.Integer.

For details, see Setting up a TCP/IP listener for J2EE called applications or Setting up the TCP/IP listener for a called non-J2EE application.
Not generated; tracing is only for use by IBM
You can find more information in the following topics in the EGL Language Reference: