Apache Ant plugin

Use the Ant plugin during deployments to automate Ant tasks defined in a build.xml file.

Apache Ant is a Java-based build tool. It is typically used to build Java applications but can also be used to build C or C++ applications. With Ant, the build process and its dependencies are described with XML.

Execute an Ant Script step

Use the Execute an Ant Script step to run an Ant script.

To use the step, open the process designer and navigate to Build > Build Tools > Ant in the Tools pane.

The following table describes the step's properties:

Property Description
Ant Script File The name of the Ant script file.
ANT_HOME The path to the Ant installation to execute the Ant script. By default, the step uses the agent’s ANT_HOME environment variable. This refers to the path up to (but not including) the bin folder.
JAVA_HOME The path to the Java installation to execute Ant. By default, the agent’s JAVA_HOME environment variable is used.
Targets (Optional) The names of the targets to run in the Ant script file. If left empty, the default target is run.
Properties (Optional) The properties passed to Ant. The properties are made available by name in the Ant script. This is supplied as a newline-separated list in the format name=value.
Ant Properties (Optional) Ant-specific arguments. For example, -v is used to indicate verbose output. This is supplied as a newline-separated list.
JVM Properties (Optional) JVM-specific arguments. For example, -Xmx=512m is used for max memory. This is supplied as a newline-separated list.
Script Content (Optional) The content of the Ant script. The value provided here is written to the Ant Script File, and then executed.

Back to top

See also: