|
|
|
WCP Data Object Tracing
Technical Note 40007
Last Reviewed 19-Sep-2008
Applies To
Verastream Host Integrator version 4.5 or higher
Summary
Technical Note 40007
Last Reviewed 19-Sep-2008
Applies To
Verastream Host Integrator version 4.5 or higher
Summary
If you are having problems running your Verastream Host Integrator (VHI) applications, you may be asked by Attachmate Technical Support to perform a WCP data object trace on your client (connector) system. This technical note describes how to generate the trace depending on the type of data object you are using.
Generating the Trace
There are two ways to generate a WCP data object trace. The method you use depends on the type of data object connector being used, Java-based or non Java-based.
Java-based Connectors
This information applies to the Java-based connectors in both Windows and UNIX environments.
Follow these steps on the machine running the client application to turn on tracing for Java-based connectors.
- On the system running the client application and connector, prepare to set WCPTRACEFILE in the vhi.properties file or an environment variable.
Version 6.5 or higher: It is recommended that you set an environment variable. The method used to set an environment variable varies depending on the operating system. On Windows XP/2000/2003, environmental variables can be set in Control Panel > System > Advanced tab > Environmental Variables.
Version 6.0 or earlier: You must modify the vhi.properties file. This file is located in the same directory as wcp.jar, typically <VHI path>/lib/java. However, in UNIX/Linux environments, see also Known Issues with Java Connector Tracing.
- Specify a trace base file name by assigning a value to the WCPTRACEFILE property or environment variable. A directory can also be specified (if omitted, trace files are generated in the "current directory" when your client application is executing and calls the connector). If a directory is specified on Windows, use double backslashes as path separators. For example:
WCPTRACEFILE=\\temp\\wcptrace- Shut down and restart the client application.
- Reproduce the problem.
The trace file will be generated in the directory with base file name as specified in step 2, and a .wcp extension. Depending on the connector version, the file name will include a date and time or number to ensure that a unique file is generated each time a trace is run. For example, wcptrace.2005_03_20.10_14_21.wcp or wcptrace1234.wcp.
Known Issues with Java Connector Tracing
In some situations the Java connector WCP trace file may not be created. Note the following issues:
- If the Java connector is running on a web server system and trace files are not generated, check the web server JVM security settings. Refer to your web server documentation.
- With connector version 6.5 or higher, to read the WCPTRACEFILE environment variable, you must be running Java version 1.3 or 1.5. Java version 1.4 does not support reading environment variables.
- With connector version 6.5 and earlier, when setting WCPTRACEFILE in vhi.properties file, tracing may not work in UNIX/Linux environments. As a workaround, follow these steps:
- Determine the "current directory" when your client application executes and calls the Java connector. For example, /home/chrism.
- Under the "current directory," create a subdirectory structure that duplicates the wcp.jar directory. For example, /home/chrism/usr/local/vhi/lib/java.
- Copy the vhi.properties file to this new directory.
- With connector version 5.5 and earlier, tracing may not work on Windows with the connector .jar files in a directory path that contains a space character (such as the typical "C:\Program Files\VHI\lib\java"). Use one of the following solutions:
- Move the .jar files to a directory not containing spaces (such as "C:\vhilibjava") and modify your project CLASSPATH appropriately.
- Uninstall and re-install Verastream to a directory not containing spaces (such as "C:\VHI").
- Use a temporary replacement wcp.jar file available for version 5.5 only and skip steps 1 and 2 above.
All Other (Non Java-based) Connectors
Follow these steps on the machine running the client application to turn on tracing for all non Java-based connectors (.NET, COM, or C).
- On the system running the client application and connector set an environment variable called WCPTRACEFILE as follows.
Version 5.5 Service Pack 2, or Version 6.0 or higher: Specify a value for the base file name, optionally with a directory, for example, WCPTRACEFILE=wcptrace or WCPTRACEFILE=C:\temp\wcptrace. (If a directory is omitted, <VHI path>\etc\tracing is used.)
Versions 4.5 through 5.5 Service Pack 1: Specify a value for the base file name only, for example, WCPTRACEFILE=wcptrace. Do not specify a directory. (The directory <VHI path>\etc\tracing is used.)
The method used to set an environment variable varies depending on the operating system. On Windows XP/2000/2003, environmental variables can be set in Control Panel > System > Advanced tab > Environmental Variables.
- If you are using the .NET connector and/or the Microsoft IIS web server, save your data, close all applications, and then restart the client machine.
- Start the client application and reproduce the problem.
The trace file will be generated in the directory with base file name as specified in step 1, and a .wcp extension. Depending on the connector version, the file name will include a date and time or number to ensure that a unique file is generated each time a trace is run. For example, wcptrace.2005_03_20.10_14_21.wcp or wcptrace1235.wcp.
