Build descriptor options

A Build Descriptor part controls the generation process. Build descriptor options are one of several types of information in a build descriptor part. Build descriptor options specify how to generate the output for your generatable parts, and a subset of the build descriptor options can cause other build parts to be used during the generation process, or additional output files to be created during the generation process.

The next two tables list all the build descriptor options that can be used. The first table shows whether the option can be used to guide Java™ or JavaScript™ generation. The second table lists each option, summarizes the function of the option, and gives the default value.

Table 1. Build descriptor option platform dependencies
Build descriptor option Java

Java
iSeries

Java-
Script

bidiConversionTable Yes Yes No
bidiRuntime Yes No No
cicsj2cTimeout Yes Yes No
currencyLocation Yes Yes No
currencySymbol Yes Yes No
dbContentSeparator Yes Yes No
dbms Yes Yes No
decimalSymbol Yes Yes No
defaultDateFormat Yes Yes No
defaultMoneyFormat Yes Yes No
defaultNumericFormat Yes Yes No
defaultServiceTimeout Yes No Yes
defaultSessionCookieID No No Yes
defaultTimeFormat Yes Yes No
defaultTimeStampFormat Yes Yes No
deploymentDescriptor Yes Yes Yes
destDirectory Yes Yes No
destHost Yes Yes No
destPassword Yes Yes No
destPort Yes Yes No
destUserID Yes Yes No
eliminateSystemDependentCode Yes Yes Yes
enableJavaWrapperGen Yes Yes No
genDataTables Yes Yes No
genDirectory Yes Yes No
genFormGroup Yes No No
genHelpFormGroup Yes No No
genProject Yes Yes No
genProperties Yes Yes No
includeLineNumbers Yes Yes No
j2ee Yes Yes No
j2eeLevel Yes Yes No
linkage Yes Yes No
msgTablePrefix Yes Yes No
nextBuildDescriptor Yes Yes Yes
prep Yes Yes No
programPackageName Yes Yes No
resourceAssociations Yes Yes No
secondaryTargetBuildDescriptor Yes Yes No
separatorSymbol Yes Yes No
serverType Yes Yes No
sessionBeanID Yes Yes No
spacesZero Yes Yes No
sqlCommitControl Yes Yes No
sqlDB Yes Yes No
sqlID Yes Yes No
sqlJDBCDriverClass Yes Yes No
sqlJNDIName Yes Yes No
sqlPassword Yes Yes No
sqlSchema Yes Yes No
sqlValidationConnectionURL Yes Yes No
storeJSFRecordAsBytes Yes Yes No
synchOnTrxTransfer Yes Yes No
system Yes Yes Yes
targetNLS Yes Yes No
tempDirectory Yes Yes No
truncateExtraDecimals Yes Yes No
useCurrentSchema Yes Yes No
userMessageFile Yes Yes No
validateSQLStatements Yes Yes No
Table 2. Build descriptor option descriptions and default values
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.
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

For Java, determined by the locale of the vgj.nls.code 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 of the vgj.nls.code 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.

defaultDateFormat No default value

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.
defaultSessionCookieID JSESSIONID Identifies the session cookie provided to the EGL Rich UI Proxy from a service.
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 services deployment descriptor file; this is created to provide service binding information for programs, libraries, handlers, and other services that invoke service functions.
destDirectory If destHost is specified, the default directory is the same as where the build server was started; if destHost is not specified, the default is determined by the genDirectory build descriptor 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.
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.
includeLineNumbers NO Specifies whether or not Java runtime error messages contain the line number of the error.
j2ee NO Specifies whether a Java program is generated to run in a J2EE environment.
j2eeLevel No default value Specifies the J2EE level of the Web application server to which an EGL-generated Web service or service-binding library will be deployed.
linkage No default value Contains the name of the linkage options part that guides aspects of generation.
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.
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.
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 For Java, determined by the locale of the vgj.nls.code runtime property. Specifies the symbol for separating the thousands and hundreds in a numeric value.

For Java, also assigns a character to 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.
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 a Java program at run time.
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 in a Java program at run time.
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.
storeJSFRecordAsBytes NO Specifies whether EGL saves a record (or record array) as bytes or as an object in session scope storage.
synchOnTrxTransfer NO Specifies whether a commit point occurs when one the following kinds of programs runs a transfer to transaction statement:
  • A main program in a Java environment
  • A main program that is generated for z/OS® batch
  • A main program that is generated for IMS™ BMP, as described in "Runtime configurations"
system No default value Specifies the target runtime environment of the generated code. This option is required.
targetNLS Based on the locale of the workstation that does generation. Specifies the target 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, or rounded off.
useCurrentSchema NO If YES, EGL will prepend the contents of the sqlLib.currentSchema system variable to all SQL table names at runtime.
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.
validateSQLStatements NO Indicates whether SQL statements are validated against a database at generation time.

Feedback