To run the Windchill Configuration Assistant, enter an ant command in one of the following general formats:

The targets for WindchillConfigAssistant.xml can be grouped as follows:

The following sections describe the targets that are supported for configuration options.

The following list describes the targets that you can use to calculate recommended configuration values and write them to intermediate properties files.

If the -Dinteractive=false command line argument is set, you are not prompted to confirm the recommended values.

The list that follows describes the targets that can be selected to propagate property values from intermediate files. The Windchill Configuration Assistant uses the xconfmanager utility to propagate Windchill properties.

Before running the propagate targets, the assistant checks to ensure that the associated intermediate files exist. If a required intermediate file does not exist, the assistant returns an error stating that fact before attempting to propagate related property values. To correct the problem, you can rerun the corresponding target that produces the intermediate file.

Embedded Servlet Engine (formerly know as Tomcat) properties are not managed by the xconfmanager utility. Following the initial installation, the Embedded Servlet Engine installation directory contains a properties file named config.properties and an ant build script called config.xml. Embedded Servlet Engine configuration files are regenerated from a template file using values from the associated config.properties. The following file (which contains the value for the mode property) is regenerated when the config.xml script is run, and any manual edits that had been made are lost:

The following table describes the targets that you can use to roll back the configuration changes that were propagated by the assistant.

The assistant uses the ConfigurationRef element in the site.xconf file to establish the link between site-managed property values maintained in the site.xconf file and those values set as a result running the configure and configureWindchill targets.

The xlink:href value set in the ConfigurationRef element is the partial file path to the windchillconfigurator.xconf file. For example:

If the ConfigurationRef element is not already present, it is automatically added to the site.xconf file when you include -Dpropagate=true on an ant command that executes either the configure or configureWindchill target.

If you want to use the propagate or propagateWindchill target to propagate the values stored in the windchillconfigurator.xconf file, the ConfigurationRef element must be in the site.xconf file before the target is executed.

The following table describes the targets that you can use to add and remove the ConfigurationRef element:

The Windchill Configuration Assistant can be run with or without user interaction. By default the assistant runs in interactive mode. In interactive mode, the user is prompted to accept or override property values calculated by the assistant as it runs each internal target.

To run the assistant in unattended mode, include -Dinteractive=false on the ant command:

In unattended mode, the assistant uses the calculated property values as though they were accepted by the user.

The targets for which the -Dinteractive=false argument is valid are as follows:

If you specify other targets on the ant command, the assistant does not check the value of the interactive property when it runs. Therefore, the -Dinteractive=false argument is not used.

When the Windchill Configuration Assistant runs a target that calculates recommended configuration values, it stores updated property name/value pairs in the file named:

The properties in this XCONF file can be propagated by the xconfmanager utility through to the various property files that it manages if the ConfigurationRef element has been added to the site.xconf file as described in the section “Targets for the site.xconf ConfigurationRef Element”.

The Windchill Configuration Assistant has the option to call xconfmanager utility to propagate all calculated property values to the appropriate properties files. By default, the Windchill Configuration Assistant does not propagate values; therefore, unless you explicitly set the value of the propagate argument to true on the ant command line when you are executing valid targets, the calculated property values are not propagated.

To run the assistant in propagation mode, include -Dpropagate=true on the ant command:

The targets for which the -Dpropagate=true argument is valid are as follows:

If you specify other targets on the ant command, the assistant does not check the value of the propagate property when it runs. Therefore, the -Dpropagate=true argument is not used.

When you are working in interactive mode, each recommended value is displayed in an [input] line on the command line. For example:

If there is a current value defined, it is included on the line in the parenthetical phrase (current=x) where x is the current value. In the example, the current value is 1.

The recommended value is the value supplied at the end of the line inside the brackets []. In the example, the recommended value is 2.

Some inputs require specific values. When this is the case, the acceptable values are presented in parentheses at the end of the input line and the recommended value is inside brackets []. For example, the following input line shows the free and total values as the values you can enter and the recommended value is free:

To override the recommended value, enter a new value at the prompt and press return. To accept the recommended value, just press return.

Include the -D<Property>=<Value> argument on the command line to override a select group of property values.

The assistant defines the following properties so that you can override calculated values for the CPU count, physical memory (in mega bytes), free memory (in mega bytes), and vendor that are calculated when running the configureWindchill target:

For a specified property value to be used, the named property must be one that is calculated through the specified target. For example, executing the following command on a system with 4 CPUs and 8 GB of RAM overrides the calculated values for CPU, physical memory, free memory, and vendor. The command specifies 16 CPUs, 36 GB of RAM, 32 GB of free memory, and IBM Corporation as the vendor:

Setting the CPUCount, physMem, and freeMem property values on a command that is run on a desktop class system allows the assistant to calculate other values that can then be used on a server class target system.

For a list of additional properties affected by each target, see the section “Targets for WindchillConfigAssistant.xml”.