ServerCacheConfiguration Properties
This topic alphabetically lists the properties that apply to the ServerCacheConfiguration class.
ClassDescription Property
Specifies a ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
Metadata
CodeModuleCacheEntryTTL Property
Specifies the Time-To-Live (TTL) in seconds that an entry may remain in the code module cache.
Metadata
CodeModuleCacheMaxFileSpace Property
Specifies the maximum file space (in MB) to allocate for code module cache entries that overflow
from memory to disk. The default value is 10 GB.
Metadata
CodeModuleCacheMaxMemory Property
Specifies the maximum memory to allocate for code module cache entries as a percentage
of the maximum memory configured for the current Java™ Virtual Machine (JVM). The default is 10%.
Metadata
GCDCacheTTL Property
Specifies the Time-To-Live value (TTL) value (in seconds) for the Global Configuration Database (GCD) cache.
The range of values is 1 to 3600 seconds with a default of 30 seconds.
The cache is flushed following the completion of a transaction (update) and automatically reloaded on the
updating server. Following the expiration of this TTL value a database query is issued, at which time the software
determines whether the cached data is stale or not.
Multiple server configurations might require a more frequent cache update polling interval
(that is, a smaller TTL value) if GCD updates are a normal occurrence. However, since objects residing
in the GCD are designed to be static in nature, updates to GCDCacheTTL are unlikely.
Metadata
Id Property
A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created.
When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following
format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.
For User
and Group
classes, the Id property takes the value of the
Security Identifier (SID) rather than the 128-bit GUID. The string representation of the
SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269
.
When Active Directory is used as the directory service for IBM FileNet P8, calls to
User.get_Id()
and Group.get_Id()
always return the current SID for the
principal, even if this user or group has only historical SIDs populating the Active
Directory server.
For a given property representation, the Id property has the following characteristics:
PropertyDescription.get_Id()
is equal to PropertyTemplate.get_Id()
, which is equal to PropertyDefinition.get_PrimaryId()
.
PropertyDefinition.get_Id()
is not equal to PropertyDefinition.get_PrimaryId()
.
PropertyDefinition.get_Id()
is not equal to PropertyDescription.get_Id()
.
For a newly created document object, you can override the Id property of its associated VersionSeries
object
before you save or check in the document for the first time.
Metadata
MarkingSetCacheEntryTTL Property
Specifies the Time-To-Live (TTL) in seconds for entries in the marking set cache. When the TTL has elapsed, cached
information that has become stale is discarded and fresh data is obtained.
Metadata
MarkingSetCacheMaxEntries Property
Specifies the maximum number of entries in the marking set cache. When the maximum number is
exceeded, the least recently used marking set elements are removed to allow more recently used elements
to be cached.
Metadata
MetadataMergedScopeCacheMaxEntries Property
The maximum number of metadata merged scope caches to be retained in memory. The default is 20 caches.
Use of this property can assist you in preventing excessive memory usage on the Content Engine server.
When a merged scope cache is created and the class descriptions are loaded in the cache, the names of the
classes are mapped to the first instance of the class encountered in the ordering sequence of the object stores
to be merged.
As an example, let's say that a class in object store A is named X and has the same GUID as a class named Y
in object store B. If you merge object stores A and B, the class name of the merged scope cache (A,B) will be X,
whereas the class name of the merged scope cache (B,A) will be Y.
As you can see from this example, specifying many different orders of merged object stores could result in an excessive
number of merged scope caches being created, and can exceed the server's memory capacity. Set the value of this
property to limit the number of metadata merged scope caches that can reside in memory.
Metadata
NonPagedQueryMaxSize Property
The maximum size in rows of a non-paged query result set. This value cannot be
overridden by an individual query.
Metadata
PrincipalCacheEntryTTL Property
Specifies the Time-To-Live (TTL) in seconds for entries in the principal cache. Once the TTL has elapsed, cached
information that has become stale is discarded and fresh data is obtained.
For more information about this cache, see Security Caching.
Metadata
PrincipalCacheMaxEntries Property
Specifies the maximum number of entries allowed in the principal cache.
When the maximum number is exceeded, the least recently used principal
elements are removed to allow more recently used elements to be cached.
For more information about this cache, see Security Caching.
Metadata
QueryCountDefaultSize Property
The default number of rows in the search results that the Content Engine counts for queries
using the SQL option of
COUNT_LIMIT.
The property is used only if the
COUNT_LIMIT
option is set to zero.
You can set this property to the following values:
- Null - The Content Engine counts the number of rows as set in the QueryCountMaxSize property.
- 0 (zero) - The count will not be returned.
- N - An integer, up to the maximum specified in the QueryCountMaxSize property.
The default value is twice the value of the QueryPageDefaultSize property.
To optimize result count performance, the administrator must take into account query time limit settings on the server.
For more information, see the object store properties DefaultQueryTimeLimit, MaxQueryTimeLimit, and QueryDatabaseTimeLimit.
Metadata
QueryCountMaxSize Property
The maximum number of rows that the Content Engine counts in the search results,
if counting is enabled. This property overrides the SQL option of
COUNT_LIMIT
or the QueryCountDefaultSize property if either of those settings exceeds the value of this property.
You can set this property to the following values:
- Null - The Content Engine counts the number of rows up to the Content Engine limit, which is Integer.Max_Value.
- 0 (zero) - The count will not be returned.
- N - An integer specifying the maximum number of rows that can be counted.
The default value is twice the value of the QueryPageMaxSize property.
To optimize result count performance, the administrator must take into account query time limit settings on the server.
For more information, see the object store properties DefaultQueryTimeLimit, MaxQueryTimeLimit, and QueryDatabaseTimeLimit.
Metadata
QueryPageDefaultSize Property
The default size in rows of a query page in a result set.
Metadata
QueryPageMaxSize Property
The maximum size in rows for a query page in a result set. This value cannot be
overridden by an individual query.
Metadata
SubjectCacheEntryTTL Property
Specifies the Time-To-Live (TTL) in seconds for entries in the subject cache. The default is one hour. Once the TTL has elapsed, cached
information that has become stale is discarded and fresh data is obtained.
Metadata
SubjectCacheMaxEntries Property
Specifies the maximum number of entries allowed in the subject cache.
When the maximum number is exceeded, the least recently used Subject
elements are removed to allow more recently used elements to be cached.
Metadata
UserTokenCacheEntryTTL Property
Specifies the Time-To-Live (TTL) in seconds for entries in the user token cache. Once the TTL has elapsed, cached
information that has become stale is discarded and fresh data is obtained.
For more information about this cache, see Security Caching.
Metadata
UserTokenCacheMaxEntries Property
Specifies the maximum number of entries allowed in the user token cache.
When the maximum number is exceeded, the least recently used user token
elements are removed to allow more recently used elements to be cached.
For more information about this cache, see Security Caching.
Metadata