The build.config file contains all the project configurations required to build a project. This file allows you to move your project along with its property settings so that your development and integration environment use the same configuration and you do not need to set up the configurations again.

Note:
  • You can use the CUSTOM_BUILD_CONFIG_FILE to configure and provide a custom build.config file. For more information about configuring this property, see Configure a property in the Prerequisites topic.
  • The build.config file had a different name in a previous release, see FAQ about changes to PDSOE for more information.

This topic describes the parameters in the build.config file.

Note: Progress recommends that you do not modify the build.config file manually within Progress Developer Studio. All the parameters can be updated from the Progress Developer Studio user interface (Project Properties) with the exception of the following:
  • streamIO.enabled
  • languages.list
  • textSegGrow
  • minSize.enabled

You can update the build.config file manually to build the project outside of Progress Developer Studio.

The database and compilableFileExtensions parameters are not used with Progress Developer Studio.

For file portability, Progress recommends that you use variables instead of an absolute path for the following attributes:
  • 'buildDir'
  • 'oeide.xrefXmlDir'
  • 'oeide.preCompileCallbackRoutine'
  • 'avm.wrkDir'
  • 'avm.avmOptions.tmpDir'
  • 'avm.avmOptions.assembliesDir'
The following default variables are supported:
  • ROOT—Root location of the project.
  • WRKDIR—Working directory; set during installation
Note: system properties, system environment variables, and Eclipse variables are also supported.

The variable should be used as "${variable-name}", for example, buildDir="${ROOT}/myBuildDir".

Global parameters

Parameters Default value Description
buildDir='' — Specifies the project build directory.

This directory contains the saved r-code files. If this field is blank, then the r-code files are saved in the same directory as the source files.

oeide parameters

The following table contains the IDE-specific configurations that are only used by Progress Developer Studio for OpenEdge.

Parameter Default value Description
useSharedAVM='' false This parameter specifies whether to use a shared ABL Virtual Machine (AVM) when building projects in Progress Developer Studio.

This parameter uses a Boolean value to specify whether the project uses a shared or a dedicated AVM.
oeideEvents='' true This parameter uses a Boolean value to enable or disable oeide events. This parameter enables you to write procedures that use the ABL SUBSCRIBE statement to capture and respond to those events.
useGlobalToolboxVD='' false This parameter uses a Boolean value to enable or disable the global Visual Designer toolbox.
addDefaultParams='' true This paramter specifies whether to use the default startup parameters when starting the AVM.

This parameter uses a Boolean value to enable or disable the passing of default AVM parameters.
hideTTYConsole='' true This parameter uses a Boolean value to enable or disable the project-specific run-time console.
useProjectCompilerSettings='' false This parameter uses a Boolean value to enable or disable the use of project-specific strictOptions under compile.
saveRCode='' true This parameter uses a Boolean value to enable or disable persistant r-code on compiling sources.
xrefXmlDir='' — This parameter specifies the output value of the XREF-XML option when xrefXml.enabled='true'.

This parameter uses a string value to specify the path where cross-reference information is saved in an XML file.
preCompileCallbackRoutine='' — This parameter uses a string value to specify the path to an ABL file that is run before compilation.

For example, this option can used to set SECURITY-POLICY: XCODE-SESSION-KEY.

AVM parameters

Parameter Default value Description
wrkDir='' The project's root directory This parameter uses a string value to specify the working directory in which the AVM starts.

AVM option parameters

The following table lists the AVM option parameters (defined in the build.config file as avmOptions).

Parameter Default value Description
tmpDir='' The DLC working directory This parameter specifies the temporary directory for the AVM run time (equivalent to the -T startup parameter option).

This parameter uses a string value to specify the path.
tty.enabled='' false Flag to use _progres or prowin executables. For _progres, the value is true; otherwise, it is false.

This parameter uses a Boolean value.
startupParameters='' — This parameter uses a string value to specify the startup parameters as a string.
assembliesDir='' — Specifies the location of the Assemblies directory (equivalent to the -assemblies startup parameter option).

This parameter uses a string value.

Compile parameters

Parameter Default value Description
compilableFileExtensions='' p, w, cls, pgen, html, htm This parameter allows you to set the compilable file extensions.

Compile option parameters

The following table lists the Compile option parameters (defined in the build.config file as compileOptions).

Parameter Default value Description
multiCompile.enabled='' false To enable the COMPILER:MULTI-COMPILE attribute, set the value to true.
xcodeKey='' — XCODE option in the COMPILE statement. Specify the expression as a string.
xrefXml.enabled='' false XREF-XML option in the COMPILE statement. To enable this option, set the value to true. Specify the expression as a Boolean value.
streamIO.enabled='' false STREAM-IO option in the COMPILE statement. To enable this option, set the value to true. Specify the expression as a Boolean value.
minSize.enabled='' false MIN-SIZE option in the COMPILE statement. To enable this option, set the value to true. Specify the expression as a Boolean value.
attrSpace.enabled='' false To enable the ATTR-SPACE option in the COMPILE statement, set the value to true.

Strict option parameters

The following table lists the Strict option parameters (defined in the build.config file as strictOptions).

Parameter Default value Description
requireFullNames='' ignore This parameter specifies the OPTIONS require-full-names in the COMPILE statement. Value can be ignore, warning, or error.
requireFieldQualifiers='' ignore This parameter specifies the OPTIONS require-field-qualifiers in the COMPILE statement. Value can be ignore, warning, or error.
requireFullKeywords='' ignore This parameter specifies the OPTIONS require-full-keywords in the COMPILE statement. Value can be ignore, warning, or error.
requireReturnValues='' ignore This parameter specifies the OPTIONS require-return-values in the COMPILE statement. Value can be ignore, warning, or error.

Languages parameters

Parameter Default value Description
list='' — Comma-separated list of language segments to include in the compiled r-code.
textSegGrow='' — This parameter specifies the TEXT-SEG-GROW option. The value must be an integer. Supported only when a language list is provided.