IBM® Web Content Management (WCM) API configuration property "iterator.pagesize" controls the iterator result set size .

Technote (FAQ)


Question

You would like to use the IBM® Web Content Management (WCM) API to find and retrieve items. The WCM "Workspace Interface" provides several methods to find WCM items and the items returned are stored in an iterator object. You can increase or decrease the value of the WCM Configuration property "iterator.pagesize" to control the maximum number of items returned by the iterator at once.

Answer

For WCM version 6.1

In WCM version 6.1, the configuration parameters are managed in the WCMConfigService.properties file. This property is also set by default to allow a maximum of 250 items to be returned at once by the WCM iterator. If you require more than 250 items to be returned by the iterator, you can increase the value of the iterator.pagesize property.

Update the iterator.pagesize property which is found in the WCMConfigService.properties located in the following directory. <WP_profile_root>/PortalServer/wcm/shared/app/config/wcmservices/

For example, To set the iterator to return a maximum of 300 items, update the property.
# The number of items to return by the iterator at once
iterator.pagesize = 300

After updating the WCMConfigService.properties, you must restart WebSphere Portal for the changes to be in affect.

For WCM version 7.0
In WCM version 7.0, the configuration parameters are managed in the Configuration Service. The property iterator.pagesize does not appear to be configured by default in the IBM WebSphere Application Server administrative console > Resource environment providers > WCM WCMConfigService.

To define the custom property, access the IBM WebSphere Application Server administrative console > Resource environment providers > WCM WCMConfigService > Custom properties and add the custom property iterator.pagesize setting it's value to the desired iterator control.

For example, To set the iterator to return a maximum of 300 items, update the property.
# The number of items to return by the iterator at once
iterator.pagesize = 300

After updating the WCM WCMConfigService, you must restart WebSphere Portal for the changes to be in affect.

Troubleshooting the WCM API
You must consider that increasing the number of items returned by the iterator can affect performance. The larger the number of items returned in a single iterator object will require larger amounts of JVM.

Please refer to the following WCM API troubleshooting documentation if you experience an Out Of Memory (OOM) case after increasing the iterator.pagesize to a large value.

Troubleshooting WCM API, How To, and Sample Code

Related information

The IBM Web Content Management API
Setting service configuration properties: wp7
Web Content Management configuration services: wp7


Rate this page:

(0 users)Average rating

Document information


More support for:

IBM Web Content Manager
General

Software version:

6.1, 6.1.0, 6.1.0.0, 6.1.0.1, 6.1.0.2, 6.1.0.3, 6.1.0.4, 6.1.0.5, 6.1.5, 6.1.5.0, 6.1.5.1, 6.1.5.2, 7.0, 7.0.0.0, 7.0.0.1

Operating system(s):

AIX, IBM i, Linux, Solaris, Windows, z/OS

Software edition:

Java edition

Reference #:

1495996

Modified date:

2011-04-22

Translate my page

Machine Translation

Content navigation