Build descriptor options used with Java™
A Build Descriptor part controls the generation process. Build descriptor options specify how to generate and prepare EGL output, and a subset of the build descriptor options can cause other build parts to be included in the generation process.
The next two tables list all the build descriptor options that
you can use with Java™:
- The first table shows which platform each option can be used with.
- The second table lists the options, a description of each option's function, and its default value, if any.
| Build descriptor option | Default value | Description |
|---|---|---|
| bidiConversionTable | No default value | Identifies a bidirectional conversion table, which is needed to handle literals that contain Arabic or Hebrew characters. |
| bidiRuntime | No default value | Identifies a bidirectional runtime file, which contains options that control the bidirectional behavior for the fields in the form groups associated with an application. |
| birtEngineHome | No default value | Identifies the location of the Business Intelligence and Reporting Tools (BIRT) report engine. |
| blanksAsZero | NO | Controls what happens when you assign or compare a text variable to a numeric variable. |
| buildPlan | YES | Specifies whether a build plan is created during the generation process. |
| byteArrayOperationsForStructuredRecords | 0 (must be set to 1 to provide the performance benefit) | Provides a performance benefit in some cases, by defining how generated Java™ code handles fields in structured records. |
| cachePreparedStatements | NO | Specifies whether to cache all PreparedStatements used with a connection. |
| checkNumericOverflow | YES | Specifies whether the generated code will check for numeric overflow. |
| cicsj2cTimeout | 30000 | Assigns a value to the cso.cicsj2c.timeout Java™ runtime property, which specifies the number of milliseconds before a timeout occurs during a call that uses protocol CICSJ2C. |
| commentLevel | 1 | Specifies the extent to which EGL system comments are included in output source code. |
| currencyLocation | NONE | Specifies the location of a currency symbol
in a string representing a monetary value. For Java™, also assigns a character to the vgj.nls.currency.location Java™ runtime property. |
| currencySymbol | Determined by the locale associated with the vgj.nls.code Java™ runtime property | Specifies a currency symbol that is composed
of one to three characters. For Java™, also assigns a character to the vgj.nls.currency Java™ runtime property. |
| dbContentSeparator | | | Specifies the character used to delineate fields in a file which is used to load or unload data from the table of a relational database. |
| dbms | DB2® | Specifies the type of database accessed by the generated program. |
| decimalSymbol | Determined by the locale associated with the vgj.nls.code Java™ runtime property | Specifies the symbol to use as the decimal indicator. For Java™, also assigns a character to the vgj.nls.number.decimal Java™ runtime property. |
| deepNullCheck | YES | Specifies the compare method when compare any variable to null. |
| defaultDateFormat | No default value | Controls the initial runtime value of strLib.defaultDateFormat. For Java™, controls the value of strLib.defaultDateFormat indirectly by setting the vgj.default.dateFormat Java™ runtime property. |
| defaultMoneyFormat | No default value | Controls the initial runtime value of the strLib.defaultMoneyFormat system
variable. For Java™, controls the value of strLib.defaultMoneyFormat indirectly by setting the vgj.default.moneyFormat Java™ runtime property. |
| defaultNumericFormat | No default value | Controls the initial runtime value of the strLib.defaultNumericFormat system
variable. For Java™, controls the value of strLib.defaultNumericFormat indirectly by setting the strLib.defaultNumericFormat Java™ runtime property. |
| defaultServiceTimeout | No default value | Specifies the maximum valid number of milliseconds between a service call and the response. |
| defaultTimeFormat | No default value | Controls the initial runtime value of the strLib.defaultTimeFormat
system variable. For Java™, controls the value of strLib.defaultTimeFormat indirectly by setting the vgj.default.timeFormat Java™ runtime property. |
| defaultTimeStampFormat | No default value | Controls the initial runtime value of the strLib.defaultTimeStampFormat system
variable. For Java™, controls the value of strLib.defaultTimeStampFormat indirectly by setting the vgj.default.timestampFormat Java™ runtime property. |
| deploymentDescriptor | No default value | Contains the name of the EGL deployment descriptor. That descriptor provides service-binding detail when you are generating a service, as well as service-binding detail when you are generating a logical unit (program, library, handler, or service) that invokes a service. |
| destDirectory | If destHost is specified, default directory is the same as where the build server was started; if destHost is not specified, the default is determined by the genDirectory option. | Specifies the name of the directory that stores the output of preparation. |
| destHost | No default value | Specifies the name or numeric TCP/IP address of the target system where the build server resides. |
| destPassword | No default value | Specifies the password that EGL uses to log on to the system where preparation occurs. |
| destPort | No default value | Specifies the port on which a remote build server is listening for build requests. |
| destUserID | No default value | Specifies the user ID that EGL uses to log on to the system where preparation occurs. |
| eliminateSystemDependentCode | YES | Indicates whether the EGL generator ignores code that will never run in the target system. |
| enableJavaWrapperGen | YES (allow all) | Specifies whether all or only some of the following components can be generated when you attempt to generate the program: the program, Java™ wrapper classes, and related EJB session bean. |
| genDataTables | YES | Specifies whether you want to generate the data tables that are referenced in the program you are generating. |
| genDirectory | No default value | Specifies the fully qualified path of the directory into which EGL places generated output and preparation-status files. |
| genFixedLengthSqlLike | NO | Indicates whether a host value used in an SQL LIKE clause includes trailing blanks to conform to the fixed length of the value, if the value is of type CHAR, MBCHAR, or UNICODE. |
| genFormGroup | YES | Indicates whether to generate the form group that is referenced in the use declaration of the program being generated. |
| genHelpFormGroup | YES | Indicates whether to generate the help form group that is referenced in the use declaration of the program being generated. |
| genProject | No default value | Places the output of Java™ generation into a workbench project and automates tasks that are required for Java™ runtime setup. |
| genProperties | NO | Specifies what kind of Java™ runtime properties to generate (if any) and, in some cases, whether to generate a linkage properties file. |
| genResourceBundle | YES | Specifies whether to generate a Java™ resource bundle. |
| genVGUIRecords | YES | Indicates whether to generate the VGUI records that are referenced in converse or show statements of a web transaction. |
| includeLineNumbers | NO | Specifies whether or not Java™ runtime error messages contain the line number of the error. |
| initIORecordsOnCall | YES | Specifies when called program IO records are initialized. |
| initNonIODataOnCall | YES | Specifies when called program non-IO-record and primitive variables are initialized. |
| j2ee | NO | Specifies whether a Java™ program is generated to run in a JEE environment. |
| j2eeLevel | No default value | Specifies the level of Java™ Enterprise Edition in the application server to which you deploy an EGL web service, JSF application, or Enterprise JavaBean. |
| linkage | No default value | Contains the name of the linkage options part that guides aspects of generation. |
| minSubstringLength | 1 | Specifies whether the minimum allowed computed length for a sub-string move is 1 or 0. When you use the sub-string on a target variable, the length of the move must be at least 1. |
| msgTablePrefix | No default value | If you generate a VGUI record bean alone, specifies the message-table prefix that is stored in the VGUI record bean. |
| nextBuildDescriptor | No default value | Identifies the next build descriptor in the chain. |
| prep | YES | Specifies whether EGL begins preparation when generation completes successfully. |
| prepareAllSQLStatements | NO | Controls the kind of JDBC object that EGL uses to run an SQL statement. |
| preparedStatementCacheSize | 100 | Specifies how many prepared statements to keep in the runtime cache when the cachePreparedStatements build descriptor option is set to YES. The value is assigned to the vgj.jdbc.pstmt.cache.size Java™ runtime property. |
| programPackageName | No default value | Names the Java™ package that receives EGL-generated output during program generation. |
| resourceAssociations | No default value | Contains the name of a resource associations part, which relates record parts to files and queues on the target platforms. |
| resourceBundleLocale | No default value | Specifies a Java™ locale to be included in the name of a resource bundle that is generated for a VGUI record or for a message table, either of which is used in a web transaction. |
| secondaryTargetBuildDescriptor | No default value | Specifies a build descriptor that guides the generation of code being deployed to a web application server, while other code (which is targeted for other environments) is being generated in the same generation request. |
| separatorSymbol | Determined by the locale associated with the vgj.nls.code Java™ runtime property | Specifies the character used for separating
the thousands and hundreds in a numeric value. For Java™ generation, this specifies the generated value for the vgj.nls.number.separator Java™ runtime property. |
| serverType | No default value | Identifies the type of web server in which your output will be deployed. |
| sessionBeanID | No default value | Identifies the name of a session element in the J2EE deployment descriptor. |
| spacesZero | NO | Specifies whether a generated program includes extra code to process numeric fields that are filled with spaces. |
| sqlAccessColumnsAsBytes | NO | Specifies whether column values from a DB2® database are copied directly as bytes into an SQL record rather than being used to construct Java™ objects. The YES value provides a performance benefit but has an effect only in some cases. |
| sqlCommitControl | No default value | Assigns a value to the vgj.jdbc.default.database. commitControl Java™ runtime property, which specifies whether a commit occurs after every change to the default database. |
| sqlDB | No default value | Specifies the default database used by a generated program. |
| sqlID | No default value | Specifies a user ID that is used to connect to a database during generation-time validation of SQL statements, or for Java™ runtime. |
| sqlJDBCDriverClass | No default value | Specifies a driver class that is used to connect to a database during generation-time validation of SQL statements or for Java™ runtime in a non-J2EE environment. |
| sqlJNDIName | No default value | Specifies the default database used by a generated Java™ program that runs in J2EE. |
| sqlPassword | No default value | Specifies a password that is used to connect to a database during generation-time validation of SQL statements or for Java™ runtime. |
| sqlSchema | No default value | Sets the vgj.jdbc.schema Java™ runtime property. |
| sqlValidationConnectionURL | No default value | Specifies a URL that is used to connect to a database during generation-time validation of SQL statements. |
| synchOnTrxTransfer | NO | Specifies whether a commit point occurs when
one the following kinds of programs runs a transfer to
transaction statement:
|
| system | No default value | Specifies the target platform for generation. This option is required. |
| targetNLS | Based on the locale of the workstation that does generation. | Specifies the national language code used to identify runtime messages. |
| tempDirectory | No default value | Specifies the location where EGL places two kinds of files: the Intermediate Representation (IR) files that are created when using the EGLSDK, and the JSP files created when generating a VGWebTransaction program or VGUIRecord. |
| truncateExtraDecimals | YES | Specifies whether the additional digits after the decimal point in a numeric value will be dropped during an assignment. |
| useCurrentSchema | NO | Enables prepend of contents of sqlLib.currentSchema to SQL table names. |
| userMessageFile | No default value | Specifies the generated value for the vgj.messages.file Java™ runtime property, which specifies a properties file that includes messages you create or customize. |
| v60DecimalBehavior | Depends on vagCompatibility | Controls the precision of an even-length DECIMAL, MONEY, or PACF variable. |
| v60NumWithCharBehavior | Depends on vagCompatibility | Indicates whether to treat NUM variables in the same way as all other numeric variables in assignments and comparisons that involve CHAR variables. |
| v60NumWithDateBehavior | NO | Specifies whether the behavior of assignments from Num fields to Date fields fulfills the behavior that was in effect in EGL version 6. |
| v60SQLNullableBehavior | Depends on vagCompatibility | Specifies how EGL behaves when a null value is assigned to a variable. |
| v71AddBehavior | NO | States whether, in a specific case, the effect of the plus (+) sign is determined by the type of variable to which an expression is assigned. |
| vagCompatibility | NO | Indicates whether the generation process allows use of special program syntax. |
| validateBlankDateFields | YES | Tells whether to identify an error in the following case: the dateFormat property is in effect for a field in a text form, but the user set the field to blank. |
| validateSQLStatements | NO | Indicates whether SQL statements are validated against a database at generation time. |
| wrapperCompatibility | CURRENT | Indicates how to regenerate wrappers that you intend to use with handwritten Java™ code when the wrappers were originally generated by VisualAge® Generator 4.5, EGL 5.x, or EGL 6.x. |
| wrapperJNDIPrefix | No default value | Specifies a prefix to be added to all JNDI names for generated session beans. |
| wrapperPackageName | No default value | Specifies the package to generate Java™ wrappers into. |