D Troubleshooting

In this chapter we discuss the common troubleshooting issues with AutoVue for Agile PLM.

Troubleshooting AutoVue for Agile PLM

This section provides information for troubleshooting your AutoVue for Agile PLM installation.

Enabling Client Verbosity

To enable detailed logging, you need to set certain parameters, and set the folder where the logs are stored.

Detailed WebLogic Logs

To enable detailed logging, set STARTMODE to false in $AGILE_HOME/agileDomain/bin/startAgile.sh.

Logs will be in $AGILE_HOME/agileDomain/servers/$HOSTNAME-AgileServer.

File Manager (Tomcat logs)

Edit $AGILE_HOME/FileManager/conf/server.xml and uncomment the following valve:

<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" prefix="localhost_access_log." suffix=".txt" pattern="%h %l %u %t &quot;%r&quot; %s %b"/>

The log will be in $AGILE_HOME/FileManager/logs

File Manager VueLink Logs

To enable logging for VueLink, do the following:

• Stop Tomcat <Agile Install>/Filemgr/FileManager/bin/shutdown.sh

• Backup <Agile Install>/Filemgr/agileDomain/applications/webfs/WEB-INF/classes/log.xml

• Replace contents of <Agile Install>/Filemgr/agileDomain/applications/webfs/WEB-INF/classes/log.xml with

  <?xml version="1.0" encoding="UTF-8" ?>
  <!--!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"-->
  
  <log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'>
  
  <appender name="webfs" class="org.apache.log4j.ConsoleAppender">
  <layout class="org.apache.log4j.PatternLayout">
  <param name="ConversionPattern" value="&lt;%d&gt; &lt;%c{1}:%p&gt; %m\n"/>
  </layout>
  </appender>
  
  <appender name="viewer" class="org.apache.log4j.ConsoleAppender">
  <layout class="org.apache.log4j.PatternLayout">
  <param name="ConversionPattern" value="&lt;%d&gt; &lt;%c{1}:%p&gt; %m\n"/>
  </layout>
  </appender>
  
  <appender name="metafile" class="org.apache.log4j.ConsoleAppender">
  <layout class="org.apache.log4j.PatternLayout">
  <param name="ConversionPattern" value="&lt;%d&gt; &lt;%c{1}:%p&gt; %m\n"/>
  </layout>
  </appender>
  
  <appender name="cimmetry" class="org.apache.log4j.ConsoleAppender">
  <layout class="org.apache.log4j.PatternLayout">
  <param name="ConversionPattern" value="&lt;%d&gt; &lt;%c{1}:%p&gt; %m\n"/></layout>
  </appender>
  
  <category name="com.agile.webfs" additivity="false">
  <priority value="debug" />
  <appender-ref ref="webfs" />
  </category>
  
  <category name="com.agile.viewer" additivity="false">
  <priority value="debug" />
  <appender-ref ref="viewer" />
  </category>
  
  <category name="com.agile.metafile" additivity="false">
  <priority value="debug" />
  <appender-ref ref="metafile" />
  </category>
  
  <category name="com.cimmetry" additivity="false">
  <priority value="debug" />
  <appender-ref ref="cimmetry" />
  </category>
  </log4j:configuration>
  

• To make the change permanent, update webfs.war:

  • cd <Agile Install>/Filemgr/agileDomain/applications

  • Extract the log.xml from webfs.war:

    <Agile Install>/Filemgr/jdk/bin/jar -xvf webfs.war WEB-INF/classes/log.xml

  • Update log.xml

  • Update webfs.war: <Agile Install>/Filemgr/jdk/bin/jar -uvf webfs.war WEB-INF/classes/log.xml

• Restart Tomcat <Agile Install>/Filemgr/FileManager/bin/start_up.sh.

The output log with VueLink data is in <Agile Install>/Filemgr/FileManager/logs/catalina.out

AutoVue Detailed Client/Server Logs

The AutoVue Client/Server Deployment allows verbose logging. This is applicable when integrated with Agile PLM. Following are the two stages to enable client logging when using the AutoVue Client/Server Deployment:

1. Modify user’s AutoVue profile for VERBOSE debugging:

   • Edit <Agile Install>/avs/bin/profiles/<UserID>.ini by adding entry:

     [Logging]

     VERBOSE=DEBUG

2. Set up Java logging:

   1. Access the Java Control Panel:

      On Windows: From Start, select Control Panel, then Java.

      On Linux: Navigate to the JRE installation directory (meaning the JRE used by the web browser on the particular client machine), then into the 'bin' folder, then type ./ControlPanel.

   2. In the Java Control Panel that appears, click Advanced tab. In the Debugging option, select the check boxes-Enable tracing and Enable logging.

   3. In the Java Control Panel, click Java tab, and then select View. In the Java Runtime Environment Settings window that appears, in the "Runtime Parameters" text field enter the following line:

      -Djavaplugin.trace=true-Djavaplugin.trace.option=basic|net|cache|security|ext|liveconnect|temp-Djavaplugin.logging=true
      

   4. Click OK in the Java Runtime Environment Settings window, and click Apply in the Java tab.

   5. After launching the Applet and doing the required tests the tracing and logging files will be dumped in the windows user profile. For instance, if the client is using:

      Windows XP: The files will be dumped in c:\Documents and Settings\<User Name>\Application Data\Sun\Java\Deployment\log

      Windows 7: The files will be dumped in C:\Users\User_Name\AppData\LocalLow\Sun\Java\Deployment

Note: For more information, refer to the KM Note-Doc ID 752589.1

Errors Which May Occur While Using the AutoVue Server

Common errors that occur while using the AutoVue server are listed in the table below along with solutions.

While the Web or Java client tries to start the AutoVue server:

Table D-1 Problem and solution while trying to start the AutoVue server

Error	Reasons	Solution
jVue not found	Viewer Content URL in Admin > Server Settings > Locations > File Manager is incorrect. Incorrect client applet alias specified instead of mandatory "jVue."	Confirm that the Viewer Content URL is accessible and the jVue.jar file is listed.
An error occurred while connecting to the server. Restart the applet?	The AutoVue server or File Manager is down. Incorrect View Server URL in Admin > Server Settings > Locations > File Manager. The AutoVue server is configured incorrectly, or is unavailable	Confirm that the Viewer Server URL is accessible and returns a successful connection status.

When the Web Client or the Java Client tries to connect to a File Manager:

Table D-2 Problem and solution while connecting to a File Manager

Error	Reason	Solution
File not found	The File Manager is down. The VueServer.ini file points to incorrect File Manager.	Confirm that the File Manager is up and running.
File not found	File not present in the File Vault	No solution

If an attachment uses special fonts:

Table D-3 Problem and Solution if attachment used special fonts

Error	Reason	Solution
Fonts may not appear correctly or a file error may occur or an incorrect font substitution may occur with viewing or printing the attachment.	The computer where the Viewer is installed does not have the fonts installed.	The computer where Viewer is installed must have those special fonts installed locally. For fonts other than the ones used by the operating system, the user's profile should include a reference to the location of the fonts in the XFONTPATHS parameter.

Changing Port Numbers

Some AutoVue server port numbers can be changed in the event of a port conflict. It is important to change the port number in all referenced locations.

• Port 5099 is used for communication between the AutoVue server and its clients.

For the AutoVue server, go to the \AVS\bin folder and open the jvueserver.properties file. Locate the following port information:

# * Socket port number

jvueserver.socket.port=5099

You can change port 5099 to another available port number.

If you are changing the AutoVue server port, update the port number in the VueServlet section of the web.xml file located at AgileHome\agileDomain\applications\webfs.war\WEB-INF\ on all viewer clients. Extract webfs.war file from AgileHome\agileDomain\applications, then open the WEB-INF folder for web.xml file.

• Port 2001 is used for RMI.

For the AutoVue server, go to the \AVS\bin folder and open the jvueserver.properties file. Locate the following port information:

# * RMI Registry port number

jvueserver.rmi.port=2001

You can change port 2001 to another available port number.

Note: Refer to the AutoVue Installation and Configuration Guide for more information on port numbers.

Verify AutoVue Server

To verify the installation, do the following:

• Check the File Manager configuration. Refer to the "Testing File Manager Configuration Page" chapter of the Oracle AutoVue for Agile PLM Testing Guide.