Web Intelligence XI 3.0 Parameter Guide

Web Intelligence XI 3.
0
Web Intelligence XI 3.0 Parameter Guide
Contents
INTRODUCTION .................................................................................................................. 2
MODIFYING THE WEB INTELLIGENCE PROCESSING SERVER PARAMETERS .............................. 2
WEB I NTELLIGENCE PARAMETERS AND THEIR MEANINGS ...................................................... 3
Server Polling Interval (seconds) .................................................................................... 3
Maximum Connections .................................................................................................. 3
Allow Document Map Maximum Size Errors................................................................. 3
Caching Parameters........................................................................................................ 3
Enable Document Cache .......................................................................................... 3
Document Cache Cleanup Interval (seconds) ......................................................... 3
Cache Timeout (seconds) ......................................................................................... 4
Universe Cache Maximum Size (Universes) ........................................................... 4
Disable Cache Sharing.............................................................................................. 4
Maximum Document Cache Size (KB) .................................................................... 4
Output Cache Directory ........................................................................................... 4
Enable Real-time Cache............................................................................................ 5
Maximum Document Cache Reduction Space........................................................ 5
Maximum Documents in Cache (Documents) ........................................................ 5
Enable List Of Values Cache .................................................................................... 5
File Size Limits............................................................................................................... 6
Maximum Character Stream Size (MB): 5 ............................................................. 6
Binary Stream Maximum Size (MB) ........................................................................ 6
Images Directory............................................................................................................ 6
Timeout Settings............................................................................................................ 6
Idle Document Timeout (seconds)........................................................................... 6
Idle Connection Timeout (minutes)......................................................................... 7
Timeout Before Recycling (seconds)........................................................................ 7
Recycle/Restart Settings................................................................................................. 7
Maximum Documents Before Recycling ................................................................. 7
Timeout Before Recycling (seconds)........................................................................ 7
List of Values Settings.................................................................................................... 8
Maximum List Of Values Size (entries) ................................................................... 8
Enable List Of Values Cache .................................................................................... 8
List of Values Batch Size (entries) ............................................................................ 8
Maximum Custom Sort Size (entries)...................................................................... 8
Memory Settings............................................................................................................ 8
Enable Memory Analysis ......................................................................................... 8
Memory Lower Threshold (MB) .............................................................................. 8
Memory Upper Threshold (MB) .............................................................................. 9
Memory Maximum Threshold (MB) ....................................................................... 9
Maximum Documents per User............................................................................... 9
Idle Document Timeout (seconds)........................................................................... 9
Important WebI Processing Server Memory Usage Note:.....................................10
11/14/2008 9:48:00 AM Copyright © 2006 Business Objects. All rights reserved. Page 1
Web Intelligence XI 3.0 Parameter Guide Parameter Guide for Web Intelligence Processing Server
Introduction
This paper will discuss the parameter settings for the Web Intelligence Processing Server found in the Central
Management Console.
Note that these are arranged in order of “type” of setting. Since some settings can fall in multiple categories,
you may see them listed more than once.
Modifying the Web Intelligence Processing Server Parameters

To modify the settings for the Web Intelligence Processing Server:
1. Go to the Servers management area of the CMC.
a. Home > Servers > Servers List
2. Double Click the Web Intelligence Processing Server whose settings you want to change.
3. Make your changes on the Properties tab.
4. Click either Save or Save & Close:
a. Click Save to submit changes and restart the server so that the changes take effect immediately.
b. Click Save & Close to save the changes and close the properties page.
5. You must restart the WebI Processing Server for the changes to take effect.
6. Return to the Servers management area of the CMC and restart the WebI Job Server.
11/14/2008 9:48:00 AM Copyright © 2008 Business Objects, an SAP Company. All rights reserved. Page 2
Web Intelligence Parameters and their Meanings

Server Polling Interval (seconds)
The interval the WebI Processing Server manages entities (such as cache, session swap, timeouts).
Default: 120 seconds

Range: 100 to 10000 seconds
Maximum Connections
Maximum number of WebI documents opened at one time. This calculation is approximate as it does not
count inactive sessions swapped to disk or the connection created to analyze the number of sessions.
This can be disabled by un-checking the “Allow Document Map Maximum Size Errors” parameter.
Default: 50 connections
Range: 5 to 65535 connections
Note: A connection is any communication to the WebI Processing Server, including document sessions.
There is one connection per document session. Therefore one user can have multiple connections.
Allow Document Map Maximum Size Errors

When this parameter is disabled, then the Maximum Connections parameter is ignored.
Default: Checked (enabled)

Range: disabled or enabled
Note: Product Group is reviewing an Enhancement Request to have this parameter renamed since the
name of the parameter does not seem to match its function. It is being reviewed for future releases.
Caching Parameters
Enable Document Cache
When this parameter is on, real-time caching is possible for Web Intelligence documents when they are
viewed, or when they are generated as a result of having been run as a scheduled job.
When this parameter is off both real-time caching of Web Intelligence documents and viewing of cached
Web Intelligence documents are impossible.
Default: checked (enabled)

Range: enabled or disabled
Note: Real-time caching is done only if both this parameter and the Enable Real Time Caching parameters
are on.
Document Cache Cleanup Interval (seconds)

This sets the number of seconds that the system waits before checking the document cache for cleanup.
The cache is cleaned up based on the caching parameters listed below.

Cache Timeout (seconds)

This is how long the WebI Processing Server saves cache. Used in conjunction with the cache cleanup
interval (above), the WebI Processing Server will scan at that interval and determine if this timeout has been
reached or exceeded and remove it if necessary.

Universe Cache Maximum Size (Universes)

This determines how many universes can be saved in cache. The default location of the WebI Processing
Server Universe cache is:
Windows
<BOInstallDir>\BusinessObjects Enterprise 12.0\Data\<server_port>\storage\universes
Unix
<BOInstallDir>/bobje/data/<server_port>/storage/universes
Default: 20 Universes
Range: 0 to 65535 Universes
Disable Cache Sharing

This setting allows for cache sharing between different instances of the WebI Processing Server. Disabling
this parameter allows one cache per instance of the WebI Processing Server that will not be shared with
other instances.
This allows privacy between WebI Processing Server instances if required.
Default: Unchecked (enabled)

Maximum Document Cache Size (KB)

This is the maximum size of a WebI document that can be stored in cache. This is not the same as
“Maximum Documents in Cache” which limits the number of documents to store, not the file size.
Default: 1,000,000 KB
Range: 10240 to 2000000000 KB
Note: In the BETA build of XI 3.0, this was mistakenly labeled as being measured in “documents” and not
KBs. This was corrected in the RTM build.
Output Cache Directory

This specifies the location of the WebI Processing Server cache that is generated during the scheduling of a
WebI document – this includes the cache generated when using the pre-cache options during scheduling
(PDF, HTML, XLS).
Use this parameter to allow sharing of cache between WebI Processing Servers that may be located on
separate physical servers.
If this is not set, the defaults are:
Windows
<BOInstallDir>\BusinessObjects Enterprise 12.0\Data\<server_port>\storage\docs\
Unix
<BOInstallDir>/bobje/data/<server_port>/storage/docs/
Default: not specified (defaults to directories listed above)

Range: default directory, or specified directory
Note: This parameter does not work in the RTM release of XI 3.0 or XI 3.1 BETA. It is being tracked under
ADAPT01109634 and has a target milestone of XI 3.2 (SP2 for XI 3.0).
Enable Real-time Cache

When this parameter is enabled, the Web Intelligence Processing Server caches Web Intelligence
documents at view time. The server also caches the documents when they are run as a scheduled job,
provided a pre-load caching option is enabled at schedule time.
When the parameter is off, the Web Intelligence Processing Server does not cache the Web Intelligence
documents when the documents are viewed. Nor does it cache the documents when they are run as a
scheduled job.
This parameter is taken into account only when the Enable Document Cache is enabled.

Note 1: To improve system performance, set the Maximum Documents in Cache to zero when this option is
enabled, but enter a value for Maximum Documents in Cache when this option is not enabled.
Note 2: Cache survives user and document session. Once the cache is generated, it is available for other
users until cache duration or size is reached.
Maximum Document Cache Reduction Space

Corresponds to the percentage of cache that will be flushed to allow newer actions if the max document
cache has been reached.
Default: 70 percent
Range: 1 to 100 percent
Note: This appears to mistakenly note the measurement unit in MBs in the CMC when it is actually the
maximum percentage to be cleared. This carries over into XI 3.1 BETA.
Maximum Documents in Cache (Documents)

The number of Web Intelligence documents that can be stored in cache.
Default: 0 Documents
Range: 0 to 65535 Documents
Note: To improve system performance, set this value to zero when Enable Real Time Caching is selected,
but enter a value when Enable Real-time Cache is deselected
Enable List Of Values Cache

Enables or disables caching of a list of values in the Web Intelligence Processing Server cache.

File Size Limits

Maximum Character Stream Size (MB): 5
Maximum size of a text stream (for example: HTML, XML) that will be transferred to the application server. If
a text stream sent to the application server is greater than this limit, the generation is stopped to protect the
server and an error is returned.
Default: 5 MB
Range: 1 to 65535 MB
Note: If your application server needs to convert XML to HTML for display, set the value of this parameter to
less than 1/5 of the memory available on the application server for the XML transformation.
XML transformation requires:

5 * (size of XML) * (number of users for whom the transformation is executed)
For example, an XML file of 5 MB transformed for 10 users requires:

5 * 5 MB * 10 users = 250 MB of memory
Binary Stream Maximum Size (MB)

This is the maximum size of a binary file (for example: *.pdf, *.xls) that can be transferred from one module
to another. If a binary file generated from a Web Intelligence document is greater than this limit, the
generation is stopped to protect the server and an error is returned.
Increase this limit if the server has to generate large binary files (for example, if InfoView users view large
documents in *.pdf format).
Default: 50 MB
Images Directory
The directory where images used in WebI documents are stored. In previous versions of the XI Suite, the
images directory was added via the command line.
The default images directories are:
Windows
<BOInstallDir>\BusinessObjects Enterprise 12.0\images\
Unix
<BOInstallDir>/bobje/enterprise120/images/
Default: not specified (defaults to directories listed above)

Range: default directory or other specified directory
Timeout Settings
Idle Document Timeout (seconds)
This setting specifies the session swap time. When the client has not communicated with the processing
server for this specified time period, then the session is swapped on disk.
The document is written to disk when first opened under WebI’s temp directory location, by default this is:
<BOInstallDir>\BusinessObjects Enterprise 12.0\Data\<server_port>\<CMS>
When the document is swapped to disk from memory, this is the “disk” location. Once the document is
reactivated, WebI loads it into memory from this temp location.
When the document session is ended (by closing the document or by reaching its idle timeout), the temp
files are removed.

Idle Connection Timeout (minutes)

A connection is any communication to or from the WebI Processing Server. This includes a document
session. One document session is equivalent to one connection.
This setting allows for the WebI Processing Server session to remain idle for the specified time before timing
out the connection.
This setting does not apply to refreshing the document and long running queries. If a query takes over 20
minutes to return data from the database, the Web Intelligence Processing server sends keep-alive requests
to the CMS preventing the connection from being timed out until the refresh is complete.
Increase this setting if it is required that the session remain idle for greater than 20 minutes after a document
has been opened and/or processed.
Default: 20 minutes
Range: 1 to 65535 minutes
Note: The timeout is for the WebI Processing Server session. There is one WebI session per document,
therefore a 1 to 1 relationship which means one user session could have multiple connections.
Timeout Before Recycling (seconds)

This specifies the inactivity timeout for the WebI Processing Server. If the WebI Processing Server has been
inactive (idle) for this time period, it will recycle itself.
Note: The Maximum Documents Before Recycling must be reached before the WebI Processing Server will
recycle.
Recycle/Restart Settings
Maximum Documents Before Recycling
This specifies how many documents WebI will process before restarting itself. By default, the WebI
Processing Server will process 50 documents and then recycle (start/stop) automatically.
Default: 50 documents
Range: 10-1000 documents
Note: The Timeout Before Recycling must be reached after the last document is processed before the
WebI Processing Server will restart. This will prevent the WebI Processing Server from restarting while
there are active sessions.
Timeout Before Recycling (seconds)

This specifies the inactivity timeout for the WebI Processing Server. If the WebI Processing Server has been
inactive (idle) for this time period, it will recycle itself.

List of Values Settings

Maximum List Of Values Size (entries)
This sets the maximum number of values that can be entered into a prompt.
Default: 50000 entries

Range: 1000 to 10000000 entries
Note: This does not set the max number of values that can be returned. That would be set in the Universe
parameters. This CMC WebI Server setting limits the number of entries that can be entered (selected or
pasted) into a prompt.
Enable List Of Values Cache

Enables or disables caching of a list of values in the Web Intelligence Processing Server cache.

List of Values Batch Size (entries)

This sets the maximum number of values that can be returned per list of values batch. For example, if the
number of values in a list of values exceeds this size, then the list of values will be returned to the user in
several batches of this size or less.
Default: 1000 entries per batch

Maximum Custom Sort Size (entries)

This limits the number of custom sorted values that can be returned.
Default: 100 entries

Memory Settings
Enable Memory Analysis
This parameter enables the 3 Memory Management parameters for the WebI Processing (Lower, Upper and
Maximum Memory Threshold parameters described below).
Default: checked (enabled)

Note: To correctly understand the behavior depending on the memory consumption, please refer to the
online help.
Memory Lower Threshold (MB)

Threshold of consumed memory after inactive sessions are swapped on disk.
Default: 1000 MB
Note: Enable Memory Analysis must be checked for this parameter to take affect.
Memory Upper Threshold (MB)

This is the “safe” memory limit for the WebI Processing Server. Once the server instance hits this limit, it will
no longer allow any document actions other than “saves” until the server has successfully cleaned memory.
If this limit is exceeded and reaches the “Memory Maximum Threshold” (below), document sessions will be
closed one by one until this Upper Threshold is reached.
Default: 1500 MB
Memory Maximum Threshold (MB)

This is the maximum amount of memory that the WebI Processing Server can use to generate a report.
All WebI documents will be killed one by one until the Memory Upper Threshold is reached.
Default: 1800 MB
Maximum Documents per User

Max number of WebI sessions (equates to documents opened) allowed per user session. Once this limit is
exceeded, the oldest document is swapped out of memory.
When the document is swapped to disk from memory, this is the “disk” location. Once the
document is reactivated, WebI loads it into memory from this temp location.
When the document session is ended (by closing the document or by reaching its Idle Connection
Timeout), the temp files are removed.
Default: 5 document sessions

Range: 1 to 20 documents
Idle Document Timeout (seconds)

This setting specifies the session swap time. When the client has not communicated with the processing
server for this specified time period, then the session is swapped on disk.
When the document is swapped to disk from memory, this is the “disk” location. Once the document is
reactivated, WebI loads it into memory from this temp location.
When the document session is ended (by closing the document or by reaching its idle timeout), the temp
files are removed.

Important WebI Processing Server Memory Usage Note:

When a document session is closed or swapped to disk, WebI will not release all of the memory that had
been utilized by those sessions. Instead, WebI keeps memory allocated.
This memory is unused, but will be reused for subsequent requests. This is a performance enhancement to
avoid WebI having to reallocate memory. This unused memory is released when the WebI Processing
Server is restarted.
If this behavior causes WebI to run an environment out of available memory, try tweaking the Recycling
settings to cause more frequent restarts of the WebI Processing Server to force a release of the unused
memory.

Web Intelligence XI 3.0 Parameter Guide

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Web Intelligence XI 3.0 Parameter Guide

Uploaded by

Copyright:

Available Formats

Web Intelligence XI 3.

Modifying the Web Intelligence Processing Server Parameters

Web Intelligence Parameters and their Meanings

Default: 120 seconds

Allow Document Map Maximum Size Errors

Default: Checked (enabled)

Default: checked (enabled)

Document Cache Cleanup Interval (seconds)

Default: 120 seconds

Cache Timeout (seconds)

Default: 4370 seconds

Universe Cache Maximum Size (Universes)

Disable Cache Sharing

This allows privacy between WebI Processing Server instances if required.

Default: Unchecked (enabled)

Maximum Document Cache Size (KB)

Output Cache Directory

If this is not set, the defaults are:

Default: not specified (defaults to directories listed above)

Enable Real-time Cache

Default: Checked (enabled)

Maximum Document Cache Reduction Space

Maximum Documents in Cache (Documents)

Enable List Of Values Cache

Default: Checked (enabled)

File Size Limits

XML transformation requires:

For example, an XML file of 5 MB transformed for 10 users requires:

Binary Stream Maximum Size (MB)

The default images directories are:

Default: not specified (defaults to directories listed above)

Default: 300 seconds

Idle Connection Timeout (minutes)

Timeout Before Recycling (seconds)

Timeout Before Recycling (seconds)

Default: 1200 seconds

List of Values Settings

Default: 50000 entries

Enable List Of Values Cache

Default: Checked (enabled)

List of Values Batch Size (entries)

Default: 1000 entries per batch

Maximum Custom Sort Size (entries)

Default: 100 entries

Default: checked (enabled)

Memory Lower Threshold (MB)

Memory Upper Threshold (MB)

Memory Maximum Threshold (MB)

Maximum Documents per User

Default: 5 document sessions

Idle Document Timeout (seconds)

Default: 300 seconds

Important WebI Processing Server Memory Usage Note:

You might also like