Setting Build Properties
The build.properties file controls the build settings for the repository-based build process. The file contains a set of switches that enable and disable the build tasks for the corresponding runtimes in the build.
To set the build properties
1. Open the following file in a text editor:
Software AG_directory \common\AssetBuildEnvironment\master_build\build.properties
2. Set the following build properties:
sag.install.dirThe path to the installation directory of the Software AG products.
build.source.dir A list with the full paths to the source directories that contain assets to build. Use a forward slash “/” as path separator. All source directories in the list must contain project directories (such as IS packages, CAF projects, and TN exports) as direct children. Use “;” as the delimiter when listing more than one path. For example:
/<root_path>/<project_name>/IS;/<root_path>/<project_name>/TN
Where <root_path> is the root directory of the source, <project_name>/IS is the project directory holding Integration Server assets, and <project_name>/TN is the project directory holding Trading Networks assets.
Most products do not have restrictions or a naming convention for the source directory that contains their assets, except the products in the following table:
Product name | Naming convention or restrictions for the source directory |
AgileApps Cloud | AgileAppsCloud |
API Gateway | APIGateway |
Broker | Broker |
Integration Server | |
Universal Messaging | UniversalMessaging |
build.output.dir The root directory in which the build script will place the output (composites and descriptors) of the build. Use a forward slash "/" as path separator. For example:
build.output.dir=<root_path>/build/
In the output directory, the build script creates a subdirectory with the current build number and a subdirectory for the composites and descriptors for each runtime type included in the build. The following table lists the name of the subdirectory that the build creates for each product:
For this product | The build creates a subdirectory with name |
ActiveTransfer | MFT |
AgileApps Cloud | AgileAppsCloud |
API Gateway | APIGateway |
Application Platform | ApplicationPlatform |
BPM Process Development | BPM |
Broker | Broker |
Business Rules | Rules |
Digital Event Services | DES |
Event Routing | EDA |
Integration Server | IS |
My webMethods Server | MWS |
Optimize | Optimize |
Trading Networks | TN |
Task Engine | TaskEngine |
Universal Messaging | UniversalMessaging |
build.source.project.dir A list of paths to the project directories that contain the assets to build. Use a forward slash “/” as path separator. This property is different from build.source.dir, because you use it to define individual project directories. Use “;” as the delimiter when listing more than one path.
enable.build.ProductID With this property, you can enable or disable building the composites for specific runtimes included in the build. Valid values are true (build composites for the specified runtime) and false (exclude the specified runtime from the build). Each runtime has a separate property that you must specify on a separate line, for example:
enable.build.UniversalMessaging=true
enable.build.IS=true
The following sample lists the enable build property for each runtime:
enable.build.MFT= # ActiveTransfer
enable.build.AgileApps= # AgileApps Cloud
enable.build.APIGateway=
enable.build.ApplicationPlatform=
enable.build.IS= # Integration Server
enable.build.MWS= # My webMethods Server. Set to "false" if building Task Engine assets.
enable.build.BPM= # BPM Process Development
enable.build.TN= # Trading Networks
enable.build.TaskEngine= # Set to "false" if building My webMethods Server assets.
enable.build.Optimize=
enable.build.Broker=
enable.build.DES= # Digital Event Services
enable.build.EDA= # Event Routing
enable.build.Rules= # Business Rules
enable.build.UniversalMessaging=
enable.archive Specifies whether the build script archives the output directory. Valid values are true (create an archive) and false (do not create an archive). If you set this field to true, you must provide a value for build.archive.dir.
build.archive.dir Required if enable.archive is set to true. Path to the archive directory for the output. The build script creates a new subdirectory with the name of the build number and moves the contents of the output directory (set in build.output.dir) to the archive directory.
build.version Version number of the current build. The build script appends an automatically-generated incremental build number to this property to get the final build number. For example, if you set this property to 9.12, the generated build number for the first build is 9.12.1 and the build number for the next build is 9.12.2.
enable.checkout Specifies whether the build script should check out the source files from a VCS. Valid values are
true (enables the check-out task) and
false (disables the check-out task). When the checkout is enabled, the build script invokes the default target you set in the build-source-checkout.xml file. For details about configuring the properties in build-source-checkout.xml to synchronize with your VCS system, see
Setting VCS Checkout Properties.
build.log.enable Specifies whether to enable logging for the build. Valid values are true (enable logging) and false (disable logging).
build.log.fileName The name of the log file. The default file name is build.log. The build script creates the log file in the following directory:
Software AG_directory \common\AssetBuildEnvironment\bin
build.logLevel The logging level for the messages recorded in the log. Valid values are:
debug - Debug, informational, warning, error, and fatal messages.
error - Error and fatal messages.
info (default) - Informational, warning, error, and fatal messages.
verbose - No possible values defined for log level.
warn - Warning, error, and fatal messages.
3. To push composites and descriptors to a Git repository, specify values for the Git properties listed in
Setting Git Properties. 4. For some of the products, you must specify build properties specific to the product. Based on which products you want to include in the build, configure the product-specific build properties as described in:
5. Save and close the file.