Wave TSG Best Practices

Configuring Log4j on Apache and Documentum

Content Server

Author

Fred Hyun

Date

10/31/2011

Version

1.0

www.wave-tsg.com
8805 Research Dr., Suite 100
Irvine, CA 92618
(888) 696-WAVE

Wave TSG

Configuring Log4j on Apache and Documentum Content Server

Revision & Sign-off Sheet

Change Record
Date

Author

Version

Change Reference

10/31/2010

Fred Hyun

1.0

Initial Draft

Reviewers
Name

Version Approved

Position

Date

Distribution
Name

WAVE Technology Solutions Group

Position

Page i

Revision 1.0

Wave TSG

Configuring Log4j on Apache and Documentum Content Server

CONTENTS
1.0 UPDATE LOG4J ON APACHE......................................................................................................... 1
1.

Update Webtop Log4J.Properties........................................................................................ 1

2.0 UPDATE LOG4J ON CONTENT SERVER AND JAVA METHOD SERVER...................................4

2.1

Shutdown Java Method Server........................................................................................... 4

2.2

Update (Documentum\config) Java Method Server Log4J.Properties...............................5

2.3

Update (JBOSS) Java Method Server Log4J.Properties...................................................8

2.4

Restart Java Method Server............................................................................................. 11

11
2.5

Restart The Docbase........................................................................................................ 11

WAVE Technology Solutions Group

Page ii

Revision 1.0

Wave TSG

Configuring Log4j on Apache and Documentum Content Server

1.0 UPDATE LOG4J ON APACHE

1. UPDATE WEBTOP LOG4J.PROPERTIES
Browse to the following location in Windows Explorer:
<DRIVE>:\<TOMCAT DIRECTORY>\webapps\webtop\WEB-INF\classes
Open the file using notepad: log4j.properties

WAVE Technology Solutions Group

Page 1

Revision 1.0

Wave TSG

Configuring Log4j on Apache and Documentum Content Server

Add the following lines of code (BOLD) after the LAST RED LINE BELOW
1. Copy the line of code starting from # Enable log messages from IV packages
2. Modify the directory (Listed below in GREEN) of the log file to match the <DRIVE LETTER> and
<TOMCAT DIRECTORY> on the server.
EXAMPLE - STAGE SERVER DIRECTORY:
D\:/Tomcat/logs/IV.log
D\:/Tomcat/logs/IV_Wave.log

log4j.rootCategory=WARN, file, stdout

log4j.category.MUTE=OFF
log4j.appender.stdout.threshold=ERROR
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %c - %m%n
log4j.appender.file.File=${user.dir}/documentum/logs/documentum.log
log4j.appender.file.MaxFileSize=10MB
log4j.appender.file.MaxBackupIndex=10
log4j.appender.file.Append=false
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %c - %m%n
# Enable log messages from IV packages
log4j.logger.com.iv=DEBUG,IVAppender
log4j.additivity.com.iv=false
log4j.appender.IVAppender=org.apache.log4j.RollingFileAppender
log4j.appender.IVAppender.File=C\:/Program Files/Apache Software Foundation/Tomcat
6.0/logs/IV.log
WAVE Technology Solutions Group

Page 2

Revision 1.0

Wave TSG

Configuring Log4j on Apache and Documentum Content Server

log4j.appender.IVAppender.MaxFileSize=100MB
log4j.appender.IVAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.IVAppender.layout.ConversionPattern=%d{dd MM yyyy HH\:mm\:ss} %p %c %m %n
# Enable log messages from Wave packages
log4j.logger.com.wave=DEBUG,WaveAppender
log4j.additivity.com.wave=false
log4j.appender.WaveAppender=org.apache.log4j.RollingFileAppender
log4j.appender.WaveAppender.File=C\:/Program Files/Apache Software Foundation/Tomcat
6.0/logs/IV_Wave.log
log4j.appender.WaveAppender.MaxFileSize=100MB
log4j.appender.WaveAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.WaveAppender.layout.ConversionPattern=%d{dd MM yyyy HH\:mm\:ss} %p %c %m
%n
_______________________________________________________________________________________
Save and close the log4j.properties file.

WAVE Technology Solutions Group

Page 3

Revision 1.0

Wave TSG

Configuring Log4j on Apache and Documentum Content Server

2.0 UPDATE LOG4J ON CONTENT SERVER AND JAVA METHOD SERVER

2.1

SHUTDOWN JAVA METHOD SERVER

a. Login to the Documentum Content Server. (ie., IVSVAPP21)
b. Open Services (All Programs > Administrative Tools > Services)
c.

Stop the Documentum Java Method Server service.

NOTE: Please wait 3-5 minutes for the Java Method Server to completely shut down.

WAVE Technology Solutions Group

Page 4

Revision 1.0

Wave TSG

2.2

Configuring Log4j on Apache and Documentum Content Server

UPDATE (DOCUMENTUM\CONFIG) JAVA METHOD SERVER LOG4J.PROPERTIES

Browse to the following location in Windows Explorer:

<DRIVE>:\Documentum\config\
Open the file using notepad: log4j.properties

WAVE Technology Solutions Group

Page 5

Revision 1.0

Wave TSG

Configuring Log4j on Apache and Documentum Content Server

1. Copy the line of code starting from # Enable log messages from IV package
2. Modify the directory (Listed below in GREEN) of the log file to match the <DRIVE LETTER> and
<Documentum DIRECTORY> on the server.
EXAMPLE - STAGE SERVER DIRECTORY (Make sure the file name is iv.log):
e\:/Documentum/logs/iv.log
Please verify the directory by comparing to the existing directories in the log4j.properties files:
EXAMPLE: log4j.appender.F1.File=e\:/Documentum/logs/log4j.log
Add the following lines of code (BOLD) after the LAST LINE BELOW (RED):
log4j.rootCategory=DEBUG, A1, F1
log4j.category.MUTE=OFF
log4j.additivity.tracing=false
log4j.category.tracing=DEBUG, FILE_TRACE
#------------------- CONSOLE -------------------------log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.threshold=ERROR
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %c - %m%n
#------------------- FILE -------------------------log4j.appender.F1=org.apache.log4j.RollingFileAppender
log4j.appender.F1.File=e\:/Documentum/logs/log4j.log
log4j.appender.F1.MaxFileSize=10MB
log4j.appender.F1.layout=org.apache.log4j.PatternLayout
log4j.appender.F1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %c - %m%n
#------------------- FILE_TRACE -------------------------log4j.appender.FILE_TRACE=org.apache.log4j.RollingFileAppender
log4j.appender.FILE_TRACE.File=e\:/Documentum/logs/trace.log
log4j.appender.FILE_TRACE.MaxFileSize=100MB
WAVE Technology Solutions Group

Page 6

Revision 1.0

Wave TSG

Configuring Log4j on Apache and Documentum Content Server

log4j.appender.FILE_TRACE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE_TRACE.layout.ConversionPattern=%d{ABSOLUTE} [%t] %m%n
# Enable log messages from IV package
log4j.appender.IVAppender=org.apache.log4j.RollingFileAppender
log4j.appender.IVAppender.File=E\:/Documentum/logs/iv.log
log4j.appender.IVAppender.MaxFileSize=10MB
log4j.appender.IVAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.IVAppender.layout.ConversionPattern=%d{dd MM yyyy HH\:mm\:ss} %p %c %m %n
# Enable log messages from IV package
log4j.logger.com.iv=DEBUG,IVAppender
log4j.additivity.com.iv=true
# Enable log messages from Wave package
log4j.logger.com.wave=DEBUG,IVAppender
log4j.additivity.com.wave=true
# Enable log messages from Aspose package
log4j.logger.com.aspose=DEBUG,IVAppender
___________________________________________________________________________

Save and close the log4j.properties file.

WAVE Technology Solutions Group

Page 7

Revision 1.0

Wave TSG

2.3

Configuring Log4j on Apache and Documentum Content Server

UPDATE (JBOSS) JAVA METHOD SERVER LOG4J.PROPERTIES

Browse to the following location in Windows Explorer:

<DRIVE>:\ Documentum\jboss4.2.0\server\DctmServer_MethodServer\deploy\ServerApps.ear\APPINF\classes
Open the file using notepad: log4j.properties

WAVE Technology Solutions Group

Page 8

Revision 1.0

Wave TSG

Configuring Log4j on Apache and Documentum Content Server

1. Copy the line of code starting from # Enable log messages from IV package
2. Modify the directory (Listed below in GREEN) of the log file to match the <DRIVE LETTER> and
<Documentum DIRECTORY> on the server.
EXAMPLE - STAGE SERVER DIRECTORY:
e\:/Documentum/logs/iv.log
Please verify the directory by comparing to the existing directories in the log4j.properties files:
EXAMPLE: log4j.appender.F1.File=e\:/Documentum/logs/log4j.log
Add the following lines of code (BOLD) after the LAST LINE BELOW (RED):
log4j.rootCategory=DEBUG, A1, F1
log4j.category.MUTE=OFF
log4j.additivity.tracing=false
log4j.category.tracing=DEBUG, FILE_TRACE
#------------------- CONSOLE -------------------------log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.threshold=ERROR
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %c - %m%n
#------------------- FILE -------------------------log4j.appender.F1=org.apache.log4j.RollingFileAppender
log4j.appender.F1.File=e:/Documentum/jboss4.2.0/server/DctmServer_MethodServer/logs/ServerApps
.log
log4j.appender.F1.MaxFileSize=10MB
log4j.appender.F1.layout=org.apache.log4j.PatternLayout
log4j.appender.F1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %c - %m%n
#------------------- ACS -------------------------log4j.category.acs=WARN, ACS_LOG
log4j.appender.ACS_LOG=org.apache.log4j.RollingFileAppender
WAVE Technology Solutions Group

Page 9

Revision 1.0

Wave TSG

Configuring Log4j on Apache and Documentum Content Server

log4j.appender.ACS_LOG.File=e:/Documentum/jboss4.2.0/server/DctmServer_MethodServer/logs/Acs
Server.log
log4j.appender.ACS_LOG.MaxFileSize=100KB
log4j.appender.ACS_LOG.layout=org.apache.log4j.PatternLayout
log4j.appender.ACS_LOG.layout.ConversionPattern=%d{ABSOLUTE} [%t] %m%n
#------------------- FILE_TRACE -------------------------log4j.appender.FILE_TRACE=org.apache.log4j.RollingFileAppender
log4j.appender.FILE_TRACE.File=e:/Documentum/jboss4.2.0/server/DctmServer_MethodServer/logs/S
erverApps_trace.log
log4j.appender.FILE_TRACE.MaxFileSize=100MB
log4j.appender.FILE_TRACE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE_TRACE.layout.ConversionPattern=%d{ABSOLUTE} [%t] %m%n
# Enable log messages from IV package
log4j.appender.IVAppender=org.apache.log4j.RollingFileAppender
log4j.appender.IVAppender.File=E\:/Documentum/logs/iv.log
log4j.appender.IVAppender.MaxFileSize=10MB
log4j.appender.IVAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.IVAppender.layout.ConversionPattern=%d{dd MM yyyy HH\:mm\:ss} %p %c %m %n

# Enable log messages from IV package

log4j.logger.com.iv=DEBUG,IVAppender
log4j.additivity.com.iv=true
# Enable log messages from Wave package
log4j.logger.com.wave=DEBUG,IVAppender
log4j.additivity.com.wave=true
# Enable log messages from Aspose package
log4j.logger.com.aspose=DEBUG,IVAppender
___________________________________________________________________________

Save and close the log4j.properties file.

WAVE Technology Solutions Group

Page 10

Revision 1.0

Wave TSG

2.4

Configuring Log4j on Apache and Documentum Content Server

RESTART JAVA METHOD SERVER

Click on Start Service for the Documentum Java Method Server.

NOTE: The Java Method Server will take a few minutes to start up.

2.5

RESTART THE DOCBASE

Click on Windows Start > All Programs > Documentum > Documentum Server Manager

WAVE Technology Solutions Group

Page 11

Revision 1.0

Wave TSG

Configuring Log4j on Apache and Documentum Content Server

When the Documentum Server Manager is displayed, click on the Stop button for the docbase.

After the docbase has stopped, wait a few minutes and click Start to start the docbase.

WAVE Technology Solutions Group

Page 12

Revision 1.0

Wave TSG

WAVE Technology Solutions Group

Configuring Log4j on Apache and Documentum Content Server

Page 13

Revision 1.0