Running the WAR Utility

This topic describes how to run the 3DSpace WAR Utility.

If you selected "J2EE (build EAR and WAR archives)" as the deployment option when installing the 3DSpace Service, the WAR Utility (war_setup.sh or war_setup.bat) is installed under the SERVER_INSTALL\PLATFORM\code\command\ directory. The previous ematrixwarutil\ directory will eventually be removed. For release V6R2012, it remained as an intermediate version that redirected to the new location.

This task shows you how to:

Before you begin:

You must have access privileges to install software on the target machine. On UNIX/Linux, you must log in as root. On Windows, you must belong to the Administrators group or have the privileges assigned to the Administrators group. Otherwise, you will not be able to start the installation.

If you are adding an application or re-running the WAR Utility for any reason, delete the contents of the SERVER_INSTALL\distrib\ directory before starting.

See Also
Persistent Data
Deploying the J2EE Archive File on TomEE+

Start the WAR Utility on UNIX

To start the WAR Utility on UNIX or Linux:

  1. Change to the SERVERHOME/PLATFORM/code/command/ directory.
  2. Run the setup script as follows:

    ./war_setup.sh [-OPTION]

    The following table describes command-line options that you can pass to the war_setup command:

    Command-Line OptionDescription
    -c, -createstaticcontentinwarPut static data in the generated .war archive
    -C, - donotcreatestaticcontentinwarDo not put static data in the generated .war archive
    -d DOC_INSTALL_PATH, -docinstpath DOC_INSTALL_PATHPath to the installed web application documentation. Is ignored if it contains no documentation files.
    -e, -createearfileCreate an application server archive
    -E, - donotcreateearfileDo not create an application server archive
    -h, -helpDisplay online help
    -i INSTALL_PATH, -instpath INSTALL_PATHPath to the 3DSpace Service (SERVER_INSTALL on Windows or SERVERHOME on UNIX).

    If you specify this option at the command line, you will not be prompted to enter it again (i.e., Step 1 in Complete the WAR Utility build process is omitted).

    -l FILENAME, -logpath FILENAME

    (lower-case L)

    		Path to log file

    If not specified, log output is sent to SERVER_INSTALL\logs\ematrixwar.log by default.

    -q, -quietQuiet install option
    -s N=V,..., -substitutions N=V,...Define symbols to substitute in fragments.
    -S SYMBOL, -subseparator SYMBOLDefine a separator symbol other than a comma ',' for the substitution list.
    -v, -verboseVerbose install option
    -versionDisplay the software version
    -w WEB_APP_NAME, -webappname WEB_APP_NAMEName of the web application to be deployed.

    If you specify this option at the command line, you will not be prompted to enter it again (i.e., Step 2 in Complete the WAR Utility build process is omitted).

    -z, -createstaticzipCreate a .zip file
    -Z, - donotcreatestaticzipDo not create a .zip file

    An interactive console window opens with the following text:

    Create Matrix EAR and WAR archives
----------------------------------

  3. Continue with Complete the WAR Utility build process.

Start the WAR Utility on Windows

Note: On Windows, if User Account Control (UAC) is ON, the WAR Utility must be started using the "Run as administrator" option. This applies whether you are starting the utility from the Windows Start menu or the command line.

To start the WAR Utility on Windows:

  1. Do one of the following, depending on whether you want to use the Windows Start menu or the command line:

    • Windows Start menu:

      Select the Start ENOVIA Live Collaboration WAR Utility shortcut from the Start > Programs > Dassault Systemes Software VERSION menu.

    • Command line:

      Change to the SERVER_INSTALL\PLATFORM\code\command\ directory and run the following command:

      war_setup.bat [-OPTION]

      See the table in Start the WAR Utility on UNIX for a list of command-line options that you can pass to the war_setup command.

    An interactive console window opens with the following text:

    Create Matrix EAR and WAR archives
----------------------------------

  2. If you are running in Console mode, continue with Complete the WAR Utility build process.

Complete the WAR Utility build process

You are presented with the following prompts. To change any item, type the desired information at the respective prompt. To accept the default value, simply press Enter without typing anything.

  1. Enter the Collaboration Server installation root ["SERVER_INSTALL"]?
  2. Enter the name of your web application [APPLICATION]?
  3. Enter documentation installation path (ignored if not valid)["DOC_INSTALL"]