com.businessobjects.sdk.plugin.admin.webiserveradmin
Interface IWebiServerAdmin


public interface IWebiServerAdmin

The IWebiServerAdmin interface allows you manage the metrics and performance options for the Web Intelligence Report Server.


Method Summary
 void commit()
           Commits the Web Intelligence Report Server updates to the registry.
 int getConnectionCount()
           Returns the number of connections that are currently being managed by the Web Intelligence Report Server.
 int getConnectionTimeoutMinutes()
           Returns the number of minutes of idle time before the Web Intelligence Report Server times out.
 int getConnectionTimeoutMinutesUpdate()
           Returns the updated value that identifies the number of minutes of idle time before the Web Intelligence Report Server times out.
 int getDocExpressCacheCleanupInterval()
           Returns how often the cache should be scanned.
 int getDocExpressCacheCleanupIntervalUpdate()
           Returns the updated value that determines how often the cache should be scanned.
 int getDocExpressCacheDurationMinutes()
           Returns the amount of time (in minutes) that a Web Intelligence document is stored in the serverís document cache.
 int getDocExpressCacheDurationMinutesUpdate()
           Returns the updated value that indicates the amount of time (in minutes) that a Web Intelligence document is cached.
 int getDocExpressMaxCacheSizeKB()
           Returns the maximum size (in kilobytes) that can be allocated to the Web Intelligence Report Serverís document cache.
 int getDocExpressMaxCacheSizeKBUpdate()
           Returns the updated value of the amount of space that has been allocated to the Web Intelligence Report Server's document cache.
 int getDocExpressMaxReductionSpaceOfCache()
           Returns the amount of cache space to release as a percentage of the cache size.
 int getDocExpressMaxReductionSpaceOfCacheUpdate()
           Returns the updated value for the amount of cache space released as a percentage of the maximum cache size.
 int getListOfValuesBatchSize()
           Returns the batch size for the list of values that are associated with this Web Intelligence document.
 int getListOfValuesBatchSizeUpdate()
           Returns the updated value for the batch size related to the list of values that are associated with this Web Intelligence document.
 int getMaxConnections()
           Returns the maximum number of simultaneous connections that can be managed by this Web Intelligence Report Server.
 int getMaxConnectionsUpdate()
           Returns the updated value that indicates the maximum number of simultaneous connections that can be managed by this Web Intelligence Report Server.
 int getMaxDocCacheSize()
           Returns the maximum number of Web Intelligence documents that can be cached.
 int getMaxDocCacheSizeUpdate()
           Returns the updated value that determines the maximum number of Web Intelligence documents that can be cached.
 int getTotalRequests()
           Returns the total number of requests made to the Web Intelligence Report Server.
 int getUniverseMaxCacheSize()
           Returns the number of universes that can be cached.
 int getUniverseMaxCacheSizeUpdate()
           Returns the updated value for the number of universes that can be cached.
 boolean isDocExpressEnabled()
           Returns a boolean that indicates whether Web Intelligence documents can be cached on this Web Intelligence Report Server.
 boolean isDocExpressEnabledUpdate()
           Returns the updated value that indicates whether Web Intelligence documents can be cached on this Web Intelligence Report Server.
 boolean isDocExpressRealTimeCachingEnabled()
           Returns a boolean that indicates whether real-time caching is enabled for Web Intelligence documents.
 boolean isDocExpressRealTimeCachingEnabledUpdate()
           Returns the updated value that indicates whether real-time caching is enabled for Web Intelligence documents.
 boolean isListOfValuesCacheEnabled()
           Returns a boolean that indicates whether caching is enabled for a list of values.
 boolean isListOfValuesCacheEnabledUpdate()
           Returns the updated value that indicates whether caching is enabled for a list of values.
 void setConnectionTimeoutMinutesUpdate(int minutes)
           Sets the number of minutes of idle time before the Web Intelligence Report Server times out.
 void setDocExpressCacheCleanupIntervalUpdate(int interval)
           Sets in minutes how often the cache should be scanned.
 void setDocExpressCacheDurationMinutesUpdate(int minutes)
           Sets the amount of time (in minutes) that a Web Intelligence document is cached.
 void setDocExpressEnabledUpdate(boolean enabled)
           Sets a boolean that indicates whether Web Intelligence documents can be cached on this Web Intelligence Report Server.
 void setDocExpressMaxCacheSizeKBUpdate(int size)
           Sets the maximum size (in kilobytes) of the Web Intelligence Report Server's document cache.
 void setDocExpressMaxReductionSpaceOfCacheUpdate(int maxReductionSpace)
           Sets the amount of cache space to release as a percentage of the maximum cache size.
 void setDocExpressRealTimeCachingEnabledUpdate(boolean enabled)
           Sets a boolean that indicates whether real-time caching is enabled for Web Intelligence documents.
 void setListOfValuesBatchSizeUpdate(int batchSize)
           Sets the batch size for a list of values.
 void setListOfValuesCacheEnabledUpdate(boolean enabled)
           Sets a boolean that indicates whether caching is enabled for a list of values.
 void setMaxConnectionsUpdate(int maxConnection)
           Sets the maximum number of simultaneous connections that can be managed by this Web Intelligence Report Server.
 void setMaxDocCacheSizeUpdate(int size)
           Sets the maximum number of Web Intelligence documents that can be cached.
 void setUniverseMaxCacheSizeUpdate(int size)
           Sets the number of universes that can be cached.
 

Method Detail

getMaxConnectionsUpdate

public int getMaxConnectionsUpdate()
                            throws SDKException

Returns the updated value that indicates the maximum number of simultaneous connections that can be managed by this Web Intelligence Report Server. This value is retrieved from the registry and can be updated by using setMaxConnectionsUpdate.

Returns:
An int that indicates the maximum number of simultaneous connections.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getMaxConnections, setMaxConnectionsUpdate

setMaxConnectionsUpdate

public void setMaxConnectionsUpdate(int maxConnection)
                             throws SDKException

Sets the maximum number of simultaneous connections that can be managed by this Web Intelligence Report Server.

For updates to take affect you must do the following:

Restart the Web Intelligence Report Server.

Once the server has been restarted both getMaxConnectionsUpdate, and getMaxConnections will share the same value.

If you use commit without restarting the Web Intelligence Report Server, then the two methods will retrieve different values. The getMaxConnections will retrieve the value that is stored with the current instance of the Web Intelligence Report Server, and the getMaxConnectionsUpdate will return the updated value stored in the registry.

Parameters:
maxConnection - An int that indicates the maximum simultaneous connections.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getMaxConnections, getMaxConnectionsUpdate

getConnectionTimeoutMinutesUpdate

public int getConnectionTimeoutMinutesUpdate()
                                      throws SDKException

Returns the updated value that identifies the number of minutes of idle time before the Web Intelligence Report Server times out. This value is retrieved from the registry and can be updated by using setConnectionTimeoutMinutesUpdate.

The connection timeout controls the number of minutes that can pass before an inactive userís Web Intelligence session times out. A shorter timeout frees up resources from inactive users more quickly. However, if the user tries to access the session after it times out, an error will occur.

Returns:
An int that indicates the number of minutes of idle time before the server times out.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getConnectionTimeoutMinutes, setConnectionTimeoutMinutesUpdate

setConnectionTimeoutMinutesUpdate

public void setConnectionTimeoutMinutesUpdate(int minutes)
                                       throws SDKException

Sets the number of minutes of idle time before the Web Intelligence Report Server times out.

The connection timeout controls the number of minutes that can pass before an inactive userís Web Intelligence session times out. A shorter timeout frees up resources from inactive users more quickly. However, if the user tries to access the session after it times out, an error will occur.

For updates to take affect you must do the following:

Restart the Web Intelligence Report Server.

Once the server has been restarted both getConnectionTimeoutMinutesUpdate, and getConnectionTimeoutMinutes will share the same value.

If you use commit without restarting the Web Intelligence Report Server, then the two methods will retrieve different values. The getConnectionTimeoutMinutes will retrieve the value that is stored with the current instance of the Web Intelligence Report Server, and the getConnectionTimeoutMinutesUpdate will return the updated value stored in the registry.

Parameters:
minutes - An int that indicates the number of minutes of idle time before the server times out.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getConnectionTimeoutMinutes, getConnectionTimeoutMinutesUpdate

isDocExpressEnabledUpdate

public boolean isDocExpressEnabledUpdate()
                                  throws SDKException

Returns the updated value that indicates whether Web Intelligence documents can be cached on this Web Intelligence Report Server. This value is retrieved from the registry and can be updated by using setDocExpressEnabledUpdate.

If you want to enable caching you will need to set the setDocExpressEnabledUpdate to true. However, this will only enable caching for Web Intelligence documents that have been scheduled. Therefore, once a Web Intelligence document is scheduled and processed it will be stored in the cache for a certain amount of time.

If you want to enable caching for Web Intelligence documents that have been viewed, you will need to set both the setDocExpressEnabledUpdate and the setDocExpressRealTimeCachingEnabledUpdate to true. Therefore, once a Web Intelligence document is viewed it will be stored in the cache.

If you have enabled caching (or real-time caching) on the Web Intelligence Report Server, you can select the formats to pre-load the cache with when a Web Intelligence document is scheduled or viewed. For more information see the following methods:

Note: The amount of time that a Web Intelligence document resides in the cache is determined by getDocExpressCacheDurationMinutes.

Returns:
true if caching is enabled, and false otherwise.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
isDocExpressEnabled, setDocExpressEnabledUpdate

setDocExpressEnabledUpdate

public void setDocExpressEnabledUpdate(boolean enabled)
                                throws SDKException

Sets a boolean that indicates whether Web Intelligence documents can be cached on this Web Intelligence Report Server.

For updates to take affect you must do the following:

Once the server has been restarted both isDocExpressEnabled, and isDocExpressEnabledUpdate will share the same value.

If you use commit without restarting the Web Intelligence Report Server, then the two methods will retrieve different values. The will contain the original value that is stored with the current instance of the Web Intelligence Report Server, and the will contain the updated value stored in the registry.

If you want to enable caching you will need to set setDocExpressEnabledUpdate to true. However, this will only enable caching for Web Intelligence documents that have been scheduled. Therefore, once a Web Intelligence document is scheduled and processed it will be stored in the cache for a certain amount of time.

If you want to enable caching for Web Intelligence documents that have been viewed, you will need to set both the setDocExpressEnabledUpdate and the setDocExpressRealTimeCachingEnabledUpdate to true. Therefore, once a Web Intelligence document is viewed it will be stored in the cache.

If you have enabled caching (or real-time caching) on the Web Intelligence Report Server, you can select the formats to pre-load the cache with when a Web Intelligence document is scheduled or viewed. For more information see the following methods:

Note: The amount of time that a Web Intelligence document resides in the cache is determined by getDocExpressCacheDurationMinutes.

Parameters:
enabled - A boolean that indicates whether caching is enabled.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
isDocExpressEnabled, isDocExpressEnabledUpdate

getDocExpressCacheDurationMinutesUpdate

public int getDocExpressCacheDurationMinutesUpdate()
                                            throws SDKException

Returns the updated value that indicates the amount of time (in minutes) that a Web Intelligence document is cached. This value is retrieved from the registry and can be updated by using setDocExpressCacheDurationMinutesUpdate.

Returns:
An int that indicates the amount of time a Web Intelligence document is stored in the server's cache.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getDocExpressCacheDurationMinutes, setDocExpressCacheDurationMinutesUpdate

setDocExpressCacheDurationMinutesUpdate

public void setDocExpressCacheDurationMinutesUpdate(int minutes)
                                             throws SDKException

Sets the amount of time (in minutes) that a Web Intelligence document is cached.

For updates to take affect you must do the following:

Restart the Web Intelligence Report Server.

Once the server has been restarted both getDocExpressCacheDurationMinutes, and getDocExpressCacheDurationMinutesUpdate will share the same value.

If you use commit without restarting the Web Intelligence Report Server, then the two methods will retrieve different values. The getDocExpressCacheDurationMinutes will contain the original value that is stored with the current instance of the Web Intelligence Report Server, and the getDocExpressCacheDurationMinutesUpdate will contain the updated value stored in the registry.

Parameters:
minutes - An int that indicates the amount of time a Web Intelligence document is stored in the server's cache.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getDocExpressCacheDurationMinutes, getDocExpressCacheDurationMinutesUpdate

getDocExpressMaxCacheSizeKBUpdate

public int getDocExpressMaxCacheSizeKBUpdate()
                                      throws SDKException

Returns the updated value of the amount of space that has been allocated to the Web Intelligence Report Server's document cache. This value is retrieved from the registry and can be updated by using setDocExpressMaxCacheSizeKBUpdate.

Returns:
An int that indicates the size of the document cache.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getDocExpressMaxCacheSizeKB(), setDocExpressMaxCacheSizeKBUpdate(int size)

setDocExpressMaxCacheSizeKBUpdate

public void setDocExpressMaxCacheSizeKBUpdate(int size)
                                       throws SDKException

Sets the maximum size (in kilobytes) of the Web Intelligence Report Server's document cache.

For updates to take affect you must do the following:

Restart the Web Intelligence Report Server.

Once the server has been restarted both the getDocExpressMaxCacheSizeKB, and the getDocExpressMaxCacheSizeKBUpdate will share the same value.

If you use commit without restarting the Web Intelligence Report Server, then the two methods will retrieve different values. The getDocExpressMaxCacheSizeKB will contain the original value that is stored with the current instance of the Web Intelligence Report Server, and the getDocExpressMaxCacheSizeKBUpdate will contain the updated value stored in the registry.

Parameters:
size - An int that indicates the size of the document cache.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getDocExpressMaxCacheSizeKB, getDocExpressMaxCacheSizeKBUpdate

isDocExpressRealTimeCachingEnabledUpdate

public boolean isDocExpressRealTimeCachingEnabledUpdate()
                                                 throws SDKException

Returns the updated value that indicates whether real-time caching is enabled for Web Intelligence documents. This value is retrieved from the registry and can be updated by using setDocExpressRealTimeCachingEnabledUpdate.

Real-time caching indicates that Web Intelligence documents will be cached once they have been viewed. If you want to enable real-time caching for Web Intelligence documents , you will need to set both setDocExpressEnabledUpdate and setDocExpressRealTimeCachingEnabledUpdate to true.

If you have enabled real-time caching on the Web Intelligence Report Server, you can select the formats to pre-load the cache with when a Web Intelligence document is viewed.

For more information see the following methods:

Note: The amount of time that a Web Intelligence document resides in the cache is determined by the getDocExpressCacheDurationMinutes.

Returns:
true if real time caching is enabled, and false otherwise.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
isDocExpressRealTimeCachingEnabled, setDocExpressRealTimeCachingEnabledUpdate

setDocExpressRealTimeCachingEnabledUpdate

public void setDocExpressRealTimeCachingEnabledUpdate(boolean enabled)
                                               throws SDKException

Sets a boolean that indicates whether real-time caching is enabled for Web Intelligence documents.

For updates to take affect you must do the following:

Once the server has been restarted both the isDocExpressRealTimeCachingEnabled, and the isDocExpressRealTimeCachingEnabledUpdate will share the same value.

If you use commit without restarting the Web Intelligence Report Server, then the two methods will retrieve different values. The isDocExpressRealTimeCachingEnabled will contain the original value that is stored with the current instance of the Web Intelligence Report Server, and the isDocExpressRealTimeCachingEnabledUpdate will contain the updated value stored in the registry.

Real-time caching indicates that Web Intelligence documents will be cached once they have been viewed. If you want to enable real-time caching for Web Intelligence documents , you will need to set both setDocExpressEnabledUpdate and setDocExpressRealTimeCachingEnabledUpdate to true.

If you have enabled real-time caching on the Web Intelligence Report Server, you can select the formats to pre-load the cache with when a Web Intelligence document is viewed. For more information see the following methods:

Note: The amount of time that a Web Intelligence document resides in the cache is determined by the getDocExpressCacheDurationMinutes.

Parameters:
enabled - A boolean that indicates whether real-time caching is enabled.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
isDocExpressRealTimeCachingEnabled, isDocExpressRealTimeCachingEnabledUpdate

isListOfValuesCacheEnabledUpdate

public boolean isListOfValuesCacheEnabledUpdate()
                                         throws SDKException

Returns the updated value that indicates whether caching is enabled for a list of values. This value is retrieved from the registry and can be updated by using setListOfValuesCacheEnabledUpdate.

Use the setListOfValuesCacheEnabledUpdate to enable or disable list of value caching.

Note: A list of values is a set of values that are associated with a universe object. These values are the corresponding values found for an object in the database. For example, the Quarter object could have the following list of values: {Q1, Q2, Q3, Q4}.

Returns:
true if caching is enabled for a list of values, and false otherwise.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
isListOfValuesCacheEnabled, setListOfValuesCacheEnabledUpdate

setListOfValuesCacheEnabledUpdate

public void setListOfValuesCacheEnabledUpdate(boolean enabled)
                                       throws SDKException

Sets a boolean that indicates whether caching is enabled for a list of values.

For updates to take affect you must do the following:

Once the server has been restarted both the isListOfValuesCacheEnabled, and the isListOfValuesCacheEnabledUpdate will share the same value.

If you use commit without restarting the Web Intelligence Report Server, then the two methods will retrieve different values. The isListOfValuesCacheEnabled will contain the original value that is stored with the current instance of the Web Intelligence Report Server, and the isListOfValuesCacheEnabledUpdate will contain the updated value stored in the registry.

Note: A list of values is a set of values that are associated with a universe object. These values are the corresponding values found for an object in the database. For example, the Quarter object could have the following list of values: {Q1, Q2, Q3, Q4}.

Parameters:
enabled - A boolean that indicates whether caching is enabled for a list of values.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
isListOfValuesCacheEnabled, isListOfValuesCacheEnabledUpdate

getListOfValuesBatchSizeUpdate

public int getListOfValuesBatchSizeUpdate()
                                   throws SDKException

Returns the updated value for the batch size related to the list of values that are associated with this Web Intelligence document. This value is retrieved from the registry and can be updated by using setListOfValuesBatchSizeUpdate.

The list of values that are returned from a prompt are returned in batches. This method allows you to determine the number of records that are contained in each batch. The batch size cannot be equal to or less than zero.

Note: A list of values is a set of values associated with a universe object. These values are the corresponding values found for an object in the database. For example, the Quarter object could have the following list of values: {Q1, Q2, Q3, Q4}.

Returns:
An int that indicates the updated batch size for a list of values.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getListOfValuesBatchSize, setListOfValuesBatchSizeUpdate

setListOfValuesBatchSizeUpdate

public void setListOfValuesBatchSizeUpdate(int batchSize)
                                    throws SDKException

Sets the batch size for a list of values.

For updates to take affect you must do the following:

Restart the Web Intelligence Report Server.

Once the server has been restarted both getListOfValuesBatchSize, and getListOfValuesBatchSizeUpdate will share the same value.

If you use commit without restarting the Web Intelligence Report Server, then the two methods will retrieve different values. The getListOfValuesBatchSize will contain the original value that is stored with the current instance of the Web Intelligence Report Server, and the getListOfValuesBatchSizeUpdate will contain the updated value stored in the registry.

The list of values that are returned from a prompt are returned in batches. This method allows you to set the number of records that are contained in each batch. The batch size cannot be equal to or less than zero

Note: A list of values is a set of values associated with a universe object. These values are the corresponding values found for an object in the database. For example, the Quarter object could have the following list of values: {Q1, Q2, Q3, Q4}.

Parameters:
batchSize - An int that specifies the batch size for a list of values.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getListOfValuesBatchSize, getListOfValuesBatchSizeUpdate

getUniverseMaxCacheSizeUpdate

public int getUniverseMaxCacheSizeUpdate()
                                  throws SDKException

Returns the updated value for the number of universes that can be cached. This value is retrieved from the registry and can be updated by using setUniverseMaxCacheSizeUpdate.

Returns:
An int that indicates the number of universes that can be cached.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getUniverseMaxCacheSize, setUniverseMaxCacheSizeUpdate

setUniverseMaxCacheSizeUpdate

public void setUniverseMaxCacheSizeUpdate(int size)
                                   throws SDKException

Sets the number of universes that can be cached.

For updates to take affect you must do the following:

Restart the Web Intelligence Report Server.

Once the server has been restarted both the getUniverseMaxCacheSize, and the getUniverseMaxCacheSizeUpdate will share the same value.

If you use commit without restarting the Web Intelligence Report Server, then the two methods will retrieve different values. The getUniverseMaxCacheSize will contain the original value that is stored with the current instance of the Web Intelligence Report Server, and the getUniverseMaxCacheSizeUpdate will contain the updated value stored in the registry.

Parameters:
size - An int that specifies the number of universes that can be cached.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getUniverseMaxCacheSize, getUniverseMaxCacheSizeUpdate

getMaxConnections

public int getMaxConnections()
                      throws SDKException

Returns the maximum number of simultaneous connections that can be managed by this Web Intelligence Report Server. This value is retrieved from the current instance of the server. Use setMaxConnectionsUpdate to update the maximum number of simultaneous connections.

Note: The default value is 100 simultaneous connections.

Returns:
An int that indicates the maximum number of simultaneous connections.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getMaxConnectionsUpdate, setMaxConnectionsUpdate

getConnectionTimeoutMinutes

public int getConnectionTimeoutMinutes()
                                throws SDKException

Returns the number of minutes of idle time before the Web Intelligence Report Server times out. This value is retrieved from the current instance of the server. Use setMaxConnectionsUpdate to update the connection timeout.

Note: The default value is 20 minutes.

Returns:
An int that indicates the connection timeout in minutes.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getConnectionTimeoutMinutesUpdate, setConnectionTimeoutMinutesUpdate

isDocExpressEnabled

public boolean isDocExpressEnabled()
                            throws SDKException

Returns a boolean that indicates whether Web Intelligence documents can be cached on this Web Intelligence Report Server. This value is retrieved from the current instance of the server. Use setDocExpressEnabledUpdate to enable or disable the document cache.

If you want to enable caching you will need to set the setDocExpressEnabledUpdate to true. However, this will only enable caching for Web Intelligence documents that have been scheduled. Therefore, once a Web Intelligence document is scheduled and processed it will be stored in the cache for a certain amount of time.

If you want to enable caching for Web Intelligence documents that have been viewed, you will need to set both the setDocExpressEnabledUpdate and the setDocExpressRealTimeCachingEnabledUpdate to true. Therefore, once a Web Intelligence document is viewed it will be stored in the cache.

If you have enabled caching (or real-time caching) on the Web Intelligence Report Server, you can select the formats to pre-load the cache with when a Web Intelligence document is scheduled or viewed.

For more information see the following methods:

Note: To determine the amount of time that a Web Intelligence document resides in the cache use getDocExpressCacheDurationMinutes.

Returns:
true if caching is enabled, and false otherwise.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
isDocExpressEnabledUpdate, setDocExpressEnabledUpdate

getDocExpressCacheDurationMinutes

public int getDocExpressCacheDurationMinutes()
                                      throws SDKException

Returns the amount of time (in minutes) that a Web Intelligence document is stored in the serverís document cache. This value is retrieved from the current instance of the server. Use setDocExpressCacheDurationMinutesUpdate to update the time limit.

Note: The default value is 4320 minutes.

Returns:
An int that indicates the amount of time a Web Intelligence document is stored in the server's cache.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getDocExpressCacheDurationMinutesUpdate, setDocExpressCacheDurationMinutesUpdate

getDocExpressMaxCacheSizeKB

public int getDocExpressMaxCacheSizeKB()
                                throws SDKException

Returns the maximum size (in kilobytes) that can be allocated to the Web Intelligence Report Serverís document cache. This value is retrieved from the current instance of the server. Use setDocExpressMaxCacheSizeKBUpdate to update the size of the cache.

Note: The default value is 1024 KB.

Returns:
An int that indicates the size of the server's document cache.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getDocExpressMaxCacheSizeKBUpdate, setDocExpressMaxCacheSizeKBUpdate

isDocExpressRealTimeCachingEnabled

public boolean isDocExpressRealTimeCachingEnabled()
                                           throws SDKException

Returns a boolean that indicates whether real-time caching is enabled for Web Intelligence documents. This value is retrieved from the current instance of the server. Use setDocExpressRealTimeCachingEnabledUpdate to enable or disable real-time caching.

Real-time caching indicates that Web Intelligence documents will be cached once they have been viewed. If you want to enable real-time caching for Web Intelligence documents, you will need to set both setDocExpressEnabledUpdate and setDocExpressRealTimeCachingEnabledUpdate to true.

If you have enabled real-time caching on the Web Intelligence Report Server, you can select the formats to pre-load the cache with when a Web Intelligence document is viewed.

For more information see the following methods:

Note: The amount of time that a Web Intelligence document resides in the cache is determined by the getDocExpressCacheDurationMinutes.

Returns:
true if real-time caching is enabled, and false otherwise.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
isDocExpressRealTimeCachingEnabledUpdate, setDocExpressRealTimeCachingEnabledUpdate

isListOfValuesCacheEnabled

public boolean isListOfValuesCacheEnabled()
                                   throws SDKException

Returns a boolean that indicates whether caching is enabled for a list of values. This value is retrieved from the current instance of the server. Use setListOfValuesCacheEnabledUpdate to enable or disable caching.

Note: A list of values is a set of values that are associated with a universe object. These values are the corresponding values found for an object in the database. For example, the Quarter object could have the following list of values: {Q1, Q2, Q3, Q4}.

Returns:
true if caching is enabled for a list of values, and false otherwise.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
isListOfValuesCacheEnabledUpdate, setListOfValuesCacheEnabledUpdate

getListOfValuesBatchSize

public int getListOfValuesBatchSize()
                             throws SDKException

Returns the batch size for the list of values that are associated with this Web Intelligence document. This value is retrieved from the current instance of the server. Use setListOfValuesBatchSizeUpdate to update the batch size.

The list of values returned for a prompt are returned in batches. This method allows you to determine the number of records that are contained in each batch. The batch size cannot be equal to or less than zero.

Note: A list of values is a set of values that are associated with a universe object. These values are the corresponding values found for an object in the database. For example, the Quarter object could have the following list of values: {Q1, Q2, Q3, Q4}.

Returns:
An int that indicates the batch size.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getListOfValuesBatchSizeUpdate, setListOfValuesBatchSizeUpdate

getUniverseMaxCacheSize

public int getUniverseMaxCacheSize()
                            throws SDKException

Returns the number of universes that can be cached. Use setUniverseMaxCacheSizeUpdate to update the size.

Returns:
An int that indicates the number of universes that can be cached.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getUniverseMaxCacheSizeUpdate, setUniverseMaxCacheSizeUpdate

getConnectionCount

public int getConnectionCount()
                       throws SDKException

Returns the number of connections that are currently being managed by the Web Intelligence Report Server. This value is retrieved from the current instance of the server.

Returns:
An int that indicates the number of connections.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getMaxConnectionsUpdate, setMaxConnectionsUpdate

getTotalRequests

public int getTotalRequests()
                     throws SDKException

Returns the total number of requests made to the Web Intelligence Report Server.

Returns:
An int that indicates the number of total requests.
Throws:
SDKException - This is thrown if the process is unsuccessful.

commit

public void commit()
            throws SDKException

Commits the Web Intelligence Report Server updates to the registry.

Note: Updates that are committed to the registry only take affect after the Web Intelligence Report Server has been restarted.

For updates to take affect you must do the following:

Restart the Web Intelligence Report Server.

Throws:
SDKException - This is thrown if the process is unsuccessful.

getDocExpressMaxReductionSpaceOfCacheUpdate

public int getDocExpressMaxReductionSpaceOfCacheUpdate()
                                                throws SDKException

Returns the updated value for the amount of cache space released as a percentage of the maximum cache size. This value is retrieved from the registry and can be updated using setDocExpressMaxReductionSpaceOfCacheUpdate.

Returns:
An int that indicates the amount of cache space to release as a percentage of the max cache size.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
setDocExpressMaxReductionSpaceOfCacheUpdate, getDocExpressMaxReductionSpaceOfCache

setDocExpressMaxReductionSpaceOfCacheUpdate

public void setDocExpressMaxReductionSpaceOfCacheUpdate(int maxReductionSpace)
                                                 throws SDKException

Sets the amount of cache space to release as a percentage of the maximum cache size.

For updates to take affect you must do the following:

Restart the Web Intelligence Report Server.

Once the server has been restarted both the getDocExpressMaxReductionSpaceOfCache, and the getDocExpressMaxReductionSpaceOfCacheUpdate will share the same value.

If you use commit without restarting the Web Intelligence Report Server, then the two methods will retrieve different values. The getDocExpressMaxReductionSpaceOfCache will contain the original value that is stored with the current instance of the Web Intelligence Report Server, and the getDocExpressMaxReductionSpaceOfCacheUpdate will contain the updated value stored in the registry.

Parameters:
maxReductionSpace - A int that specifies the cache space to release as a percentage of the max cache size.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getDocExpressMaxReductionSpaceOfCacheUpdate, getDocExpressMaxReductionSpaceOfCache

getDocExpressCacheCleanupIntervalUpdate

public int getDocExpressCacheCleanupIntervalUpdate()
                                            throws SDKException

Returns the updated value that determines how often the cache should be scanned. This value is retrieved from the registry and can be updated using setDocExpressCacheCleanupIntervalUpdate.

Returns:
An int that indicates in minutes how often the cache will be scanned.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
setDocExpressCacheCleanupIntervalUpdate, getDocExpressCacheCleanupInterval

setDocExpressCacheCleanupIntervalUpdate

public void setDocExpressCacheCleanupIntervalUpdate(int interval)
                                             throws SDKException

Sets in minutes how often the cache should be scanned.

For updates to take affect you must do the following:

Restart the Web Intelligence Report Server.

Once the server has been restarted both the getDocExpressCacheCleanupInterval, and the getDocExpressCacheCleanupIntervalUpdate will share the same value.

If you use commit without restarting the Web Intelligence Report Server, then the two methods will retrieve different values. The getDocExpressCacheCleanupInterval will contain the original value that is stored with the current instance of the Web Intelligence Report Server, and the getDocExpressCacheCleanupIntervalUpdate will contain the updated value stored in the registry.

Parameters:
interval - An int that specifies in minutes how often the cache will be scanned.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getDocExpressCacheCleanupInterval, getDocExpressCacheCleanupIntervalUpdate

getMaxDocCacheSizeUpdate

public int getMaxDocCacheSizeUpdate()
                             throws SDKException

Returns the updated value that determines the maximum number of Web Intelligence documents that can be cached. This value is retrieved from the registry and can be updated using setMaxDocCacheSizeUpdate.

Returns:
An int that indicates the maximum number of Web Intelligence documents to cache.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
setMaxDocCacheSizeUpdate

setMaxDocCacheSizeUpdate

public void setMaxDocCacheSizeUpdate(int size)
                              throws SDKException

Sets the maximum number of Web Intelligence documents that can be cached.

For updates to take affect you must do the following:

Restart the Web Intelligence Report Server.

Once the server has been restarted both the getMaxDocCacheSize, and the getMaxDocCacheSizeUpdate will share the same value.

If you use commit without restarting the Web Intelligence Report Server, then the two methods will retrieve different values. The getMaxDocCacheSize will contain the original value that is stored with the current instance of the Web Intelligence Report Server, and the getMaxDocCacheSizeUpdate will contain the updated value stored in the registry.

Parameters:
size - An int that specifies the number of Web Intelligence documents to cache.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
getMaxDocCacheSize, getMaxDocCacheSizeUpdate

getDocExpressMaxReductionSpaceOfCache

public int getDocExpressMaxReductionSpaceOfCache()
                                          throws SDKException

Returns the amount of cache space to release as a percentage of the cache size. This value is retrieved from the registry and can be updated using setDocExpressMaxReductionSpaceOfCacheUpdate.

Returns:
An int that specifies the amount of cache to release as a percentage of the Max Cache Size
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
setDocExpressMaxReductionSpaceOfCacheUpdate

getDocExpressCacheCleanupInterval

public int getDocExpressCacheCleanupInterval()
                                      throws SDKException

Returns how often the cache should be scanned. This value is retrieved from the registry and can be updated using setDocExpressCacheCleanupIntervalUpdate.

Returns:
An int that specifies in minutes how often the cache is scanned
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
setDocExpressCacheCleanupIntervalUpdate

getMaxDocCacheSize

public int getMaxDocCacheSize()
                       throws SDKException

Returns the maximum number of Web Intelligence documents that can be cached. This value is retrieved from the registry and can be updated using setMaxDocCacheSizeUpdate.

Returns:
An int that indicates the maximum number of Web Intelligence documents to cache.
Throws:
SDKException - This is thrown if the process is unsuccessful.
See Also:
setMaxDocCacheSizeUpdate