Java run-time properties (details)

Java run-time properties (details)

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.
Run-time 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 property has no effect on calls when the code is running in WebSphere 390; for details, see Setting up the J2EE server for CICSJ2C calls.
Build descriptor option cicsj2cTimeout
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. For details, see Deploying a linkage properties file. LO is from the build descriptor option linkage; and the default value is the name of the linkage options part followed by the extension .properties
tcpiplistener.port
Specifies the number of the port on which an EGL TCP/IP listener (of class CSOTcpipListener or CSOTcpipListenerJ2EE) listens. No default exists. For details, see the topics that concern Setting up the TCP/IP listener.

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 CSOTcpipListener or CSOTcpipListenerJ2EE). 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 CSOTcpipListener or CSOTcpipListenerJ2EE). 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 the topics that concern Setting up the TCP/IP listener. Not generated; tracing is only for use by IBM
vgj.datemask. gregorian.long.locale Contains the date mask used in either of two cases:
The Java code generated for the system variable sysVar.currentFormattedDate is invoked; or
EGL validates a page item or text-form field that has a length of 10 or more, if the item property dateFormat is set to systemGregorian.

locale is the code specified in property vgj.nls.code. 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 long Gregorian date mask; the default value is specific to the locale
vgj.datemask. gregorian.short.locale Contains the date mask used when EGL validates a page item or text-form field that has a length of less than 10, if the item property dateFormat is set to systemGregorian.
locale is the code specified in property vgj.nls.code. 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 system variable sysVar.currentFormattedJulianDate is invoked; or
EGL validates a page item or text-form field that has a length of 10 or more, if the item property dateFormat is set to systemJulian.

locale is the code specified in property vgj.nls.code. 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 long Julian date mask; the default value is specific to the locale
vgj.datemask. julian.short.locale Contains the date mask used when EGL validates a page item or text-form field that has a length of less than 10, if the item property dateFormat is set to systemJulian.
locale is the code specified in property vgj.nls.code. 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.jdbc.database.SN Specifies the JDBC database name that is used when a database connection is made by way of the system function sysLib.connect or sysLib.connectionService.
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 sysLib.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.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, build descriptor option sqlJNDIName
For non-J2EE connections, build descriptor option sqlDB

vgj.jdbc.default.password Specifies the password for accessing the database connection identified in vgj.jdbc.default.database.
To avoid exposing passwords in the J2EE environment file, do one of the following tasks:
Specify a password in program and function scripts by using the system function sysLib.connect or sysLib.connectionService; or
Include a user ID and password in the datasource specification in the web application server, as described in Setting up a J2EE JDBC connection.

Build descriptor option sqlPassword
vgj.jdbc.default.userid Specifies the userid for accessing the database connection identified in vgj.jdbc.default.database. Build descriptor option sqlID
vgj.jdbc.drivers Specifices the driver class for accessing the database connection identified in vgj.jdbc.default.database. This property is not present in the deployment descriptor or J2EE environment file and is used only for a standard (non-J2EE) JDBC connection. Build descriptor option sqlJDBCDriverClass
vgj.nls.code Specifies the three-letter NLS code of the program. For a list of valid values, see targetNLS.
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

Build descriptor option targetNLS
vgj.nls.currency Specifies the character used as a currency symbol. The default is determined by the locale associated with vgj.nls.code. Build descriptor option currencySymbol
vgj.nls.number.decimal Specifies the character used as a decimal symbol. The default is determined by the locale associated with vgj.nls.code. Build descriptor option decimalSymbol
vgj.properties.file
Used only if the first program in a non-J2EE run unit was generated with VisualAge Generator or with an EGL version that preceded 6.0.
vgj.properties.file specifies an alternate properties file. The file is used throughout a non-J2EE run unit in place of any non-global program properties file. Use of the global file is unaffected. (In run units whose first program was generated with the older EGL or with VisualAge Generator, the global file is called vgj.properties.)

The file referenced by the property vgj.properties.file is used only if you include that property in a command-line directive, as in this example:
java -Dvgj.properties.file=c:\new.properties
The value of vgj.properties.file includes the fully qualified path to the properties file.

Specifying the property vgj.properties.file in a properties file has no effect.
vgj.ra.QN.conversionTable Specifies the name of the conversion table used by a generated Java program during access of the MQSeries message queue identified by QN. Valid values are programControlled, NONE, or a conversion table name. The default is NONE. Resource associations property conversionTable
vgj.ra.FN.fileType Specifies the type of file associated with FN, which is a file or queue name identified in the record part. The property value is seqws or mq, as described in Record and file type cross-reference.
You must specify this deployment descriptor property for each logical file that your program uses.
Resource associations property fileType
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.
Resource associations property replace
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.
Resource associations property systemName
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.
Resource associations property text
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
vgj.trace.type Specifies the run-time 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
Related concepts
Java run-time properties
Linkage properties file

Related tasks
Deploying a linkage properties file
Setting up a J2EE JDBC connection
Setting up the J2EE run-time environment for EGL-generated code

Setting up the TCP/IP listener for a called appl in a J2EE appl client module
Setting up the TCP/IP listener for a called non-J2EE application
Understanding how a standard JDBC connection is made

Related reference
callLink element
cicsj2cTimeout
decimalSymbol
linkage
Linkage properties file (details)
Record and file type cross-reference
sqlDB
sqlID
sqlJDBCDriverClass
sqlJNDIName
sqlPassword
sysLib.connect
sysLib.connectionService
sysLib.setLocale
sysVar.currentFormattedDate
sysVar.currentFormattedJulianDate
sysVar.currentShortDate
sysVar.currentShortJulianDate
targetNLS

Run-time 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 property has no effect on calls when the code is running in WebSphere 390; for details, see Setting up the J2EE server for CICSJ2C calls.	Build descriptor option cicsj2cTimeout
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. For details, see Deploying a linkage properties file.	LO is from the build descriptor option linkage; and the default value is the name of the linkage options part followed by the extension .properties
tcpiplistener.port	Specifies the number of the port on which an EGL TCP/IP listener (of class CSOTcpipListener or CSOTcpipListenerJ2EE) listens. No default exists. For details, see the topics that concern Setting up the TCP/IP listener. 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 CSOTcpipListener or CSOTcpipListenerJ2EE). 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 CSOTcpipListener or CSOTcpipListenerJ2EE). 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 the topics that concern Setting up the TCP/IP listener.	Not generated; tracing is only for use by IBM
vgj.datemask. gregorian.long.locale	Contains the date mask used in either of two cases: The Java code generated for the system variable sysVar.currentFormattedDate is invoked; or EGL validates a page item or text-form field that has a length of 10 or more, if the item property dateFormat is set to systemGregorian. locale is the code specified in property vgj.nls.code. 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 long Gregorian date mask; the default value is specific to the locale
vgj.datemask. gregorian.short.locale	Contains the date mask used when EGL validates a page item or text-form field that has a length of less than 10, if the item property dateFormat is set to systemGregorian. locale is the code specified in property vgj.nls.code. 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 system variable sysVar.currentFormattedJulianDate is invoked; or EGL validates a page item or text-form field that has a length of 10 or more, if the item property dateFormat is set to systemJulian. locale is the code specified in property vgj.nls.code. 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 long Julian date mask; the default value is specific to the locale
vgj.datemask. julian.short.locale	Contains the date mask used when EGL validates a page item or text-form field that has a length of less than 10, if the item property dateFormat is set to systemJulian. locale is the code specified in property vgj.nls.code. 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.jdbc.database.SN	Specifies the JDBC database name that is used when a database connection is made by way of the system function sysLib.connect or sysLib.connectionService. 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 sysLib.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.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, build descriptor option sqlJNDIName For non-J2EE connections, build descriptor option sqlDB
vgj.jdbc.default.password	Specifies the password for accessing the database connection identified in vgj.jdbc.default.database. To avoid exposing passwords in the J2EE environment file, do one of the following tasks: Specify a password in program and function scripts by using the system function sysLib.connect or sysLib.connectionService; or Include a user ID and password in the datasource specification in the web application server, as described in Setting up a J2EE JDBC connection.	Build descriptor option sqlPassword
vgj.jdbc.default.userid	Specifies the userid for accessing the database connection identified in vgj.jdbc.default.database.	Build descriptor option sqlID
vgj.jdbc.drivers	Specifices the driver class for accessing the database connection identified in vgj.jdbc.default.database. This property is not present in the deployment descriptor or J2EE environment file and is used only for a standard (non-J2EE) JDBC connection.	Build descriptor option sqlJDBCDriverClass
vgj.nls.code	Specifies the three-letter NLS code of the program. For a list of valid values, see targetNLS. 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	Build descriptor option targetNLS
vgj.nls.currency	Specifies the character used as a currency symbol. The default is determined by the locale associated with vgj.nls.code.	Build descriptor option currencySymbol
vgj.nls.number.decimal	Specifies the character used as a decimal symbol. The default is determined by the locale associated with vgj.nls.code.	Build descriptor option decimalSymbol
vgj.properties.file	Used only if the first program in a non-J2EE run unit was generated with VisualAge Generator or with an EGL version that preceded 6.0. vgj.properties.file specifies an alternate properties file. The file is used throughout a non-J2EE run unit in place of any non-global program properties file. Use of the global file is unaffected. (In run units whose first program was generated with the older EGL or with VisualAge Generator, the global file is called vgj.properties.) The file referenced by the property vgj.properties.file is used only if you include that property in a command-line directive, as in this example: java -Dvgj.properties.file=c:\new.properties The value of vgj.properties.file includes the fully qualified path to the properties file. Specifying the property vgj.properties.file in a properties file has no effect.
vgj.ra.QN.conversionTable	Specifies the name of the conversion table used by a generated Java program during access of the MQSeries message queue identified by QN. Valid values are programControlled, NONE, or a conversion table name. The default is NONE.	Resource associations property conversionTable
vgj.ra.FN.fileType	Specifies the type of file associated with FN, which is a file or queue name identified in the record part. The property value is seqws or mq, as described in Record and file type cross-reference. You must specify this deployment descriptor property for each logical file that your program uses.	Resource associations property fileType
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.	Resource associations property replace
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.	Resource associations property systemName
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.	Resource associations property text
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
vgj.trace.type	Specifies the run-time 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