Configure error logging

To assist administrators in investigating problems between a WebDAV client and the FileNet P8 WebDAV Servlet, you can enable server-side logging using log4j, which will log messages that are meaningful in the FileNet P8 Workplace environment.

FileNet P8 WebDAV servlet will log the following types of information:

Type Information
Request When a WebDAV client issues a request to the WebDAV servlet, the headers and any content contained within the body of the request are logged.
Response When dispatching a response to a WebDAV client request, any response headers and any content contained within the response body are logged.
Exception When errors are encountered and the response code sent back to the client might not be informative, the FileNet P8-specific information is logged.
Warning Condition When errors are encountered that are considered warnings but do not manifest in an error code sent to the client, a warning is logged with some explanatory text.

To configure error logging

  1. If you have not already done so, log on to the Application Engine server as an administrator.
  2. Locate the default Windows or UNIX location of the log4j.properties file. For example, the Windows location might be in C:\Program Files\FileNet\Config\AE\log4j.properties. and the UNIX location might be in opt/FileNet/Config/AE/log4j.properties.
  3. Do one of the following:
    • To enable logging on JBoss and WebLogic, add the log4j parameter to the startup script, and then start the Application Engine server. For example, you can add the following to the startup script for:

    Windows

    @REM log4j config
    @REM set log_conf="-Dlog4j.configuration=file:/C:\Progra~1\FileNet\Config\AE\log4j.properties"

    UNIX

    # log4j config
    LOG_CONF="-Dlog4j.configuration=/opt/FileNet/Config/AE/log4j.properties"

    WebLogic 8 - Windows

    Add the %log_conf% section after the CLASSPATH settings. For example:

    echo .
    echo CLASSPATH=%CLASSPATH%
    echo .
    echo PATH=%PATH%
    echo .
    echo ***************************************************
    echo * To start WebLogic Server, use a user name and *
    echo * password assigned to an admin-level user. For *
    echo * server administration, use the WebLogic Server *
    echo * console at http:\[host_name]:[port]\console *
    echo ***************************************************
    %JAVA_HOME%\bin\java %JAVA_VM% %MEM_ARGS% %JAVA_OPTIONS% %log_conf% -
    Dweblogic.Name=%SERVER_NAME% -Dweblogic.management.username=%WLS_USER% -
    Dweblogic.management.password=%WLS_PW% -
    Dweblogic.ProductionModeEnabled=%PRODUCTION_MODE% -
    Djava.security.policy="%WL_HOME%\server\lib\weblogic.policy" weblogic.Server

    WebLogic 8 - UNIX

    Add the %log_conf% section after the CLASSPATH settings as indicated in bold in the example below:

    # Log4j properties file
    LOG_CONF="-Dlog4j.configuration=/opt/FileNet/Config/AE/log4j.properties"
    # Call WebLogic Server
    echo "."
    echo "CLASSPATH=${CLASSPATH}"
    echo "."
    echo "PATH=${PATH}"
    echo "."
    echo "***************************************************"
    echo "* To start WebLogic Server, use a user name and *"
    echo "* password assigned to an admin-level user. For *"
    echo "* server administration, use the WebLogic Server *"
    echo "* console at http://[host_name]:[port]/console *"
    echo "***************************************************"
    ${JAVA_HOME}/bin/java ${JAVA_VM} ${MEM_ARGS} ${JAVA_OPTIONS} ${LOG_CONF} -
    Dweblogic.Name=${SERVER_NAME} -
    Dweblogic.ProductionModeEnabled=${PRODUCTION_MODE} -
    Djava.security.policy="${WL_HOME}/server/lib/weblogic.policy" weblogic.Server

    WebLogic 9 - Windows

    Add the %log_conf% section in the WLS_REDIRECT_LOG settings as indicated in bold in the example below:

    If “%WLS_REDIRECT_LOG%”==””(
    echo Starting WLS with line:
    echo %JAVA_HOME%\bin\java %JAVA_VM% %MEM_ARGS% %JAVA_OPTIONS% %jaas_login%
    -Dweblogic.Name=%SERVER_NAME% -
    Djava.security.policy=%WL_HOME%\server\lib\weblogic.policy %PROXY_SETTINGS%
    %SERVER_CLASS%
    %JAVA_HOME%\bin\java %JAVA_VM% %MEM_ARGS% %JAVA_OPTIONS% %log_conf% -
    Dweblogic.Name=%SERVER_NAME% -Dweblogic.management.username=%WLS_USER% -
    Dweblogic.management.password=%WLS_PW% -
    Djava.security.policy=%WL_HOME%\server\lib\weblogic.policy %PROXY_SETTINGS%
    %SERVER_CLASS%
    ) else (
    echo Redirecting output from WLS window to %WLS_REDIRECT_LOG%
    %JAVA_HOME%\bin\java %JAVA_VM% %MEM_ARGS% %JAVA_OPTIONS% %jaas_login% -
    Dweblogic.Name=%SERVER_NAME% -Dweblogic.management.username=%WLS_USER% -
    Dweblogic.management.password=%WLS_PW% -
    Djava.security.policy=%WL_HOME%\server\lib\weblogic.policy %PROXY_SETTINGS%
    %SERVER_CLASS% >”%WLS_REDIRECT_LOG%” 2>&1
    )

    WebLogic 9 - UNIX

    Add the %log_conf% section in the WLS_REDIRECT_LOG settings as indicated in bold in the example below:

    ${JAVA_HOME}/bin/java ${JAVA_VM} -version
    if [ "${WLS_REDIRECT_LOG}" = "" ] ; then
    echo "Starting WLS with line:"
    echo "${JAVA_HOME}/bin/java ${JAVA_VM} ${MEM_ARGS} ${JAVA_OPTIONS} -
    Dweblogic.Name=${SERVER_NAME} -Djava.security.policy=${WL_HOME}/server/lib/weblogic.policy
    ${PROXY_SETTINGS} ${SERVER_CLASS
    }"
    ${JAVA_HOME}/bin/java ${JAVA_VM} ${MEM_ARGS} ${JAVA_OPTIONS}
    ${JAAS_LOGIN} -Dweblogic.Name=${SERVER_NAME} -Djava.security.policy=${WL_HOME}/server/lib/weblogic.policy
    ${PROXY_SETTINGS} ${SERVER_CLASS}
    else
    echo "Redirecting output from WLS window to ${WLS_REDIRECT_LOG}"
    ${JAVA_HOME}/bin/java ${JAVA_VM} ${MEM_ARGS} ${JAVA_OPTIONS}
    ${LOG_CONF} -Dweblogic.Name=${SERVER_NAME} -Djava.security.policy=${WL_HOME}/server/lib/weblogic.policy
    ${PROXY_SETTINGS} ${SERVER_CLASS} >"${WLS_REDIRECT_LOG}" 2>&1

  4. To enable logging on WebSphere, add the log4j parameter to the WAS admin console, and then start the Application Engine server. For example, you can do the following.
    1. Open the WAS admin console in WebSphere 6.0 and navigate to Servers > Application servers > server1 > Process Definition > Java™ Virtual Machine. Find a similar path if you are not using WebSphere 6.0.
    2. In the generic JVM arguments box, add one of the following:

      Windows

      -Dlog4j.configuration=C:\Progra~1\FileNet\Config\AE\log4j.properties

      Solaris

      -Dlog4j.configuration=file:/opt/FileNet/Config/AE/log4j.properties

  5. Save and close the server startup script.


Feedback

© Copyright IBM Corporation 2013.
This information center is powered by Eclipse technology. (http://www.eclipse.org)