Configuring the Web Component Adapter

In Crystal Enterprise installations that use the Crystal Enterprise Java SDK, the Web Component Server is replaced by a Web Component Adapter (WCA) running on a Java application server. (These Crystal Enterprise installations include all UNIX installations, and any installation of Crystal Enterprise on Windows that has been configured to use the Java version of the Crystal Enterprise web desktop, as per the instructions in Crystal Enterprise Installation Guide. The WCA provides support for the Crystal Management Console and CSP applications. The Web Component Adapter is a Java web application; it does not appear as a server in the Crystal Management Console or in the Crystal Configuration Manager.

If you need to configure any of the parameters formerly controlled through the WCS, you can do so by editing the web.xml deployment descriptor file associated with the WCA.

To configure web.xml

The web.xml file used by the WCA is in the WEB-INF subdirectory of the webcompadapter.war archive file stored in the crystal_root/enterprise/JavaSDK/applications directory on UNIX, or C:\Program Files\Common Files\Crystal Decisions\2.5\jars\JavaSDK\applications on Windows.

Each of the options displayed in the CMC or the CCM for the WCS appears as a context parameter in web.xml. For example, the context parameter that controls whether a group tree will be generated looks like this:

<context-param>
<param-name>viewrpt.groupTreeGenerate</param-name>
<param-value>true</param-value>
<desctiption>"true" or "false" value determining whether a group tree will be generated.</description>
</context-param>

To change the value of a context parameter, edit the value between the <param-value> </param-value> tags.

Your Java Web Application Server may provide tools to allow you to edit web.xml directly from an administrative console. Otherwise you need to stop your application server and extract the web.xml file from the webcompadapter.war archive before editing it using a text editor such as Notepad or vi. Once you have made your changes to web.xml, you must reinsert the file into the WEB-INF directory in webcompadapter.war, and restart your application server.

Tip:    To reinsert web.xml into WEB-INF using WinZip, right-click on the WEB-INF directory that contains your edited web.xml file and select "Add to Zip File...". Adding the file in this way ensures that it is placed in the correct directory inside the archive.

When you install more than one WCA, each webcomponentadapter.war file contains its own web.xml file containing configuration parameters for that WCA. However, you can only set the parameters listed in the following table individually for each WCA. The remaining parameters must be the same for all WCA in your system.

Context Parameter	Description
display-name	Equivalent to WCA name, or friendly name of WCS
cspApplication.defaultPage	The default page that will be loaded if no filename is specified in a particular request.
cspApplication.dir	This is the real path to the directory containing the CSP/WAS application(s) that you would like to host. This is a required field.
connection.cms	This is the name (or name and port number) of the CMS that you would like your application(s) to connect to. This is equivalent to setting -requestport for the WCS.
connection.listeningPort	This field defaults to the port that the WCA related servlets are running on. This setting is equivalent to configuring the WCS to listen on a port for the web connector, using -port.
log.file	Filename of the logfile including full real path to file, excluding extension. Defaults to WCA with no path
log.ext	File extension of logfile, defaults to .log
log.isRolling	Determines whether or not the logs will be rotated, defaults to true.
log.size	If log rolling is turned on, this will govern the max size before logfile is rotated. Accepted suffix: MB, KB and GB.
log.level	The default loglevel is "error."
log.entryPattern	Please refer to log4j documentation for accepted log entry patterns.