Report Generator - Administration Guide : Client Script

1. Client Script

A client script is included in the distribution. Use one of the provided start scripts (Windows and UNIX shell scripts available) with some modifications. The modifications required are defined in the sub chapters below.

When the report generator is installed, you will have a folder under the WEB-INF directory in the web-application called reportgenerator. This folder contains a Windows start script and a UNIX start script. These scripts are called:

Client.sh
Client.bat

The script has been made as generic as possible and to use it, you will typically invoke the script with the following arguments:

The first things you need to modify within these scripts are the following variables:

Variable Name Description

USER

The name of the user, who is running the report

PASS

The password for this user

OBJECT_ID

The id of the object, for which the report is being created

REPORT

The name of the report to create

TARGET_FILE

The name of the file, which will contain the generated report. If this is set to empty:

All output handlers and converters are disabled
The extracted XML is returned

WEBAPP_ROOT_DIR

Points out where your web application is installed. This is needed as we load the JAR files and other resources dynamically from this directory.

The value can be a relative or absolute path. Since the scripts are located under ${ROOT_DIR}/WEB-INF/reportgenerator, the default value for this is: ../..

If you place the script somewhere else, you must change this variable.

Example:

WEBAPP_ROOT_DIR=d:\apps\apache-tomcat-6.0.29\webapps\enovia

QUEUE_NAME

The name of the queue to use (leave empty for no queue)

DEBUG

TRUE or FALSE. Defines the amount of output from the report generator.

JAVA

In the Windows start script, it is assumed that the JAVA_HOME variable is set. If not, this has to be set before invoking the script. For UNIX, you need to modify the script and define the JAVA home.

HEAP_SIZE

The size of the heap

CONTEXT_HOST

Specifies how to connect to ENOVIA/Matrix. If you use RIP mode, this variable is empty, while if RMI mode is used this variable will point out a RMI server.

Example:

CONTEXT_HOST=
CONTEXT_HOST=rmi://server:1099

If you connect in RIP mode, you must ensure that some additional ENV variables are set. For example the PATH and on UNIX the LD_LIBRARY_PATH among others. In the UNIX script, you can use the MX_ENV_SCRIPT variable to point out an existing mxEnv.sh script that will setup the environment correctly.