Best practices reporting issues

To quickly help you in error identification and resolution, please try to follow the guidelines below:

• Provide a detailed description of the issue; this will help us understand the problem you have.
• When possible take screenshots of all the steps you followed. The idea is to be able to reproduce the error or at least better understand the context where it occurred.
• Videos are also welcome.
• Share the stack trace from the openkm.log file

Note

Because the support website has restrictions on document size, share with us the download link using online file sharing tools like:

• https://transfer.sh/
• https://filepush.co/
• https://filetransfer.io/
• https://justbeamit.com/

Getting the stack trace

Linux

The openkm.log file is in the $TOMCAT/logs folder. For example, in Linux a common location might be “/home/openkm/tomcat-8.5.69/logs”.

To watch how openkm.log changes in real time, you can use the command line:

/home/openkm/tomcat-8.5.69/logs:$ tail -f openkm.log

To show the last 500 lines of the openkm.log file, you can use the command line:

/home/openkm/tomcat-8.5.69/logs:$ tail -n 500 openkm.log

Windows

The openkm.log file is in the $TOMCAT/logs folder. For example, in Windows a common location might be “c:\tomcat-8.5.69\logs”.

To watch how openkm.log changes in real time you can use a Windows tool like mtail.

Note

You have a copy of the mtail tool in c:\tomcat-8.5.69\extras\

Sample of stack trace capture

Caution

When you capture the stack trace, it is good practice to include some extra lines before and after the error.

2019-08-04 12:05:00,020 [Task Scheduler 18] [] INFO  c.openkm.plugin.cron.BaseCronPlugin - *** Process Pending Task task end ***
2019-08-04 12:05:00,032 [Task Scheduler 19] [] INFO  c.openkm.plugin.cron.BaseCronPlugin - *** Text Extractor Worker task end ***
2019-08-04 12:09:36,471 [http-nio-0.0.0.0-8080-exec-6] [okmAdmin] INFO  com.openkm.util.LocalEntityResolver - resolveEntity(publicId=-//OpenKM//DTD Property Groups 2.8//EN, systemId=http://www.openkm.com/dtd/property-groups-2.8.dtd) => NULL
2019-08-04 12:09:36,603 [http-nio-0.0.0.0-8080-exec-6] [okmAdmin] ERROR com.openkm.util.FormUtils - Element type "hpanel" must be declared.
2019-08-04 12:09:36,612 [http-nio-0.0.0.0-8080-exec-6] [okmAdmin] ERROR c.o.s.admin.PropertyGroupsServlet - Element type "hpanel" must be declared.
com.openkm.core.ParseException: Element type "hpanel" must be declared.
  at com.openkm.util.FormUtils.parsePropertyGroupsDefinition(FormUtils.java:308)
  at com.openkm.module.db.DbRepositoryModule.registerPropertyGroups(DbRepositoryModule.java:855)
  at com.openkm.module.db.DbRepositoryModule.registerPropertyGroups(DbRepositoryModule.java:844)
  at com.openkm.servlet.admin.PropertyGroupsServlet.doPost(PropertyGroupsServlet.java:220)
  at javax.servlet.http.HttpServlet.service(HttpServlet.java:661)
  at javax.servlet.http.HttpServlet.service(HttpServlet.java:742)
  at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:231)
  at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
  at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:52)
  at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
  at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
  at com.openkm.servlet.UserLoggingFilter.doFilter(UserLoggingFilter.java:33)
  at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
  at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
  at org.springframework.boot.web.filter.ApplicationContextHeaderFilter.doFilterInternal(ApplicationContextHeaderFilter.java:55)
  at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
  at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
  at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
  at org.springframework.boot.actuate.trace.WebRequestTraceFilter.doFilterInternal(WebRequestTraceFilter.java:110)
  at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
  at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)
  at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)
  at java.lang.Thread.run(Thread.java:748)
2019-08-04 12:10:00,000 [Task Scheduler 18] [] INFO  c.openkm.plugin.cron.BaseCronPlugin - *** Process Pending Task task begin ***
2019-08-04 12:10:00,000 [Task Scheduler 6] [] INFO  c.openkm.plugin.cron.BaseCronPlugin - *** Antivirus Checker Worker task begin ***
2019-08-04 12:10:00,000 [Task Scheduler 25] [] INFO  c.openkm.plugin.cron.BaseCronPlugin - *** Text Extractor Worker task begin ***
2019-08-04 12:10:00,014 [Task Scheduler 6] [] INFO  c.openkm.plugin.cron.BaseCronPlugin - *** Antivirus Checker Worker task end ***