JR52877: QUERY FOR ALL DOCUMENTS CAUSES SYSTEM TO BE UNRESPONSIVE AND TO SHUT DOWN WITH OUTOFMEMORYERROR

7.5.1.2-WS-BPM-IFJR52877
Version 8.5 Refresh Pack 7 for the IBM Business Process Manager products

APAR status

• Closed as program error.

Error description

• While using a human service, you see a Document Attachment
  control that does not show any documents. The HTTP request to
  retrieve the documents has been running for a long time, without
  being apparent. Depending on the setup, a timeout might occur
  and you see the following error message: ?Error retrieving
  documents list?.
  
  Depending on the number of documents in the system, the requests
  claim a large part of the Java heap, potentially shutting the
  server down by causing OutOfMemory errors. An analysis of the
  Java heap dump shows potential leaks by large arrays that
  contain com.lombardisoftware.data.DocumentShell objects.
  

Local fix

Problem summary

• By using the Document Attachment control, you can filter
  documents by either filtering on document properties or by
  showing only documents associated to the process instance. If
  none of the two filters is configured, all documents are
  displayed. Also, even when you try to filter by the associated
  process instance, a stand-alone human service will not apply
  that filter.
  
  As a result, a query for all documents is performed and the
  corresponding properties are loaded. For systems with a high
  number of documents, this operation requires time and a lot of
  heap space.
  

Problem conclusion

• A fix is available for IBM BPM V7.5.1.2 that allows you to
  disable queries for all documents in the 100Custom.xml file:
  
   <server merge="mergeChildren">
     <document-api-all-documents-query-allowed>false
     </document-api-all-documents-query-allowed>
   </server>
  
  For more information, see ?Changing server properties in
  100Custom.xml?
  (http://www.ibm.com/support/knowledgecenter/SSFPJS_7.5.1/com.ibm
  .wbpm.admin.doc/adminguide/topic/changing_server_props.html).
  
  After that setting is set to false, an error is returned when a
  query for all documents is performed.
  
  On Fix Central (http://www.ibm.com/support/fixcentral), search
  for JR52877:
  
  1. Select IBM Business Process Manager with your edition from
    the product selector, the installed version to the fix pack
    level, and your platform, and then click Continue.
  
  2. Select APAR or SPR, enter JR52877, and click Continue.
  
  When you download fix packages, ensure that you also download
  the readme file for each fix. Review each readme file for
  additional installation instructions and information about the
  fix.
  

Temporary fix

• Not applicable
  

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  BPM STANDARD

• Fixed component ID

  5725C9500

Applicable component levels

• R751 PSY

     UP