Build Targets

The client application is built using Apache Ant build scripts. These build scripts define ordered sequences of processing steps called targets. To invoke a target, you open a command prompt window and change to the <client-dir> folder and then pass the name of the target to the command you use to start Apache Ant. Typically this command is called build or appbuild. The name depends on the script provided for your application, but it will be referred to as build in this manual. For example, to build the web client application, the command is buildclient . You can run more than one target at a time by passing the target names separated by space characters. For example, buildcleanclient will first clean all the generated output that may be present before building the full web client application again.

The following build targets are available for Cúram client projects:

client: Builds the client application. See Full and Incremental Builds for further details.
clean: Deletes all of output generated by the other build targets. See Full and Incremental Builds for further details.
beandoc: Generates reference documentation for the façade server interfaces. See Server Interface Reference for further details.
client-with-previews: Builds the client application and also generates previews of the pages in HTML format in the <client-dir>/WebContent/Previews folder. See Page Previews for further details.
uimgen: Generates skeleton UIM pages from the façade server interface definitions. See UIM Generator Tool for further details.

A number of environment variables affect the build process for a web client application. Some have been introduced already and others are explained elsewhere, but all are shown below. When you install the Cúram Application, the build command will set most of these for you, as they mostly refer to files and folders that will be in fixed locations relative to where you installed the application. However, for a new application, or if you are modifying the build command, you may need to confirm that these are set correctly.

Table 1. Environment Variables
Name	Required	Description
CURAMCDEJ	Yes	The location of the installed Cúram CDEJ infrastructure. This is the same as the value of the <cdej-dir> placeholder used in this manual. See Installation for details.
CLIENT_DIR	Yes	The location of your web client application. This is the same as the value of the <client-dir> placeholder used in this manual. See Installation for details.
CLIENT_PROJECT_NAME	Yes	Defines the name of the application being built. This name is used as a base name for many generated artifacts, for example, for Java package names. The name is defined in the UML model. For the installed Cúram Application, the value should be "Curam".
LOCALE_LIST	Yes	Defines the locales that will be supported by the application. See Application Locales for details.
CLIENT_COMPONENT_ORDER	No	Defines the prioritized order of the application's components. See Component Order for details. This is not required, but it is highly recommended that you set it explicitly. By default, all components will be processed in alphabetical order.
ENCODING	No	Defines the character encoding that will be used to interpret files that do not explicitly define an encoding. By default, the system's default character encoding will be used. See File Encoding for details.
MULTIPLE_VALIDATION_ERRORS	No	Controls the number of errors that are reported during the build process before the build terminates. See Error Reporting for details.