ObjectStore Properties

Specifies a list of AddOnInstallationRecord objects corresponding to this object store.

Enumeration of the audit disposition policies defined in this ObjectStore object. Each CmAuditDispositionPolicy object in the enumeration defines the criteria in which audit records are identified for disposition (deletion).

The level of auditing on the object store on which this object is persisted. A value of 0 is returned if auditing is disabled; a value of 1 is returned if auditing is enabled. You can change the auditing level by setting this property on the ObjectStore object.

Enumeration of the audit processing bookmarks defined in this ObjectStore object. Each CmAuditProcessingBookmark object in the enumeration represents a leave-off point in the audit log (Event table) by an audit processing client.

Deprecated.
The Verity locale used for the object store. Before you can set a value for this property on the object store, a VerityDomainConfiguration object must exist.

Any valid locale name supported by Verity can be used. This value must be set before any VerityIndexArea objects are created, and may not be modified while any VerityIndexArea objects exist. If the locale is "uni" the default language code can optionally be appended to this name (such as "uni/fr" for French). When a language code is appended, queries use the specified language as the default language for word stemming and other language-specific features.

Specifying a language code here applies only to the default language used. It does not preclude the use of additional languages for the object store. Multiple languages can be indexed into Verity collections in the same object store.

Deprecated.
A boolean that enables or disables Content Engine text extraction for purposes of building content-based retrieval (CBR) indexes. Text extraction refers to the extraction of text from documents of various types, such as Microsoft Word, PDF, and so on. Set the value of this property to true to extract text from documents using Content Engine and false to extract text using the text search engine. The text search engine builds the CBR indexes using the extracted text in both cases.

Set the property value to true only if the Content Engine text extraction capabilities have been installed. If those capabilities have not be installed, Content Engine logs the error "CBRPreFilter is not deployed" to the FileNet P8 log file when it attempts to filter the text for a document.

Java Virtual Machine (JVM) options for Content Engine text extraction

Content Engine creates a separate subprocess to filter the text for each document. On occasion, a malformed document might cause a subprocess to enter an unstable state such that it can never complete its text extraction task. You can configure how long Content Engine allows a subprocess to run by setting the CBRPreFilterInitialTimeout JVM option. When a timeout occurs, Content Engine terminates the subprocess and can retry the filter operation by creating another subprocess. Use the CBRPreFilterMaxRetryCount JVM option to specify the maximum number of retry subprocesses. The descriptions for these JVM options follow:

• CBRPreFilterInitialTimeout (Integer)
  An interval in seconds that Content Engine uses to calculate the timeout intervals for the text extraction subprocesses that work on a particular document. The default value for this option is 60. The timeout interval for the initial subprocess is specified by this option value, and the interval for any subsequent retry subprocess is twice as large as the interval for the previous subprocess. That is, the calculation is as follows:

          subprocess n timeout interval = 2(n-1) * option value

  where n is one for the first subprocess, two for the second (retry) subprocess, and so on. For example, if the value for this option is 60, the timeout period for the first subprocess is 1 minute (60 seconds); for the second, 2 minutes; for the third, 4 minutes; and so on. Content Engine considers no timeout interval to be in effect when the the value for this option is zero.

• CBRPreFilterMaxRetryCount (Integer)
  The maximum number of retry subprocesses that Content Engine sequentially creates to work on a particular document. The default value for this option is 3.

Specifies the threshold for the CBR query dynamic switching optimization, used for queries that combine both a content-based retrieval (CBR) search and a relational search on a database (DB). Dynamic switching optimization determines whether the CBR search or the DB search occurs first.

This property applies only if the CBRQueryOptimization property is set to DYNAMIC_SWITCHING, and if a query does not include a SQL optimization option. If this property is not set, the CBR search always executes first. If this propety is set to zero, the DB search always executes first.

For more information, see CBR Query Optimization.

Specifies how searches that combine both full text and relational query conditions are executed. The property takes a CBRQueryOptimization value. The property applies to the IBM Content Search Services engine only.

A full-text search on indexed content is a content-based retrieval (CBR) search. A relational search on properties is a database (DB) search. If the property is set to NONE (0 or null), the Content Engine always performs the CBR search first and the DB search second. If the property is set to DYNAMIC_SWITCHING (1), then the Content Engine dynamically determines whether to issue the CBR search first or the DB search first, optimizing performance for these types of searches.

In dynamic switching mode, the Content Engine switches from CBR first to DB first based on an estimated number of CBR hits. The estimate is compared to a threshold value, set in the CBRQueryDynamicThreshold property. If you set this property to DYNAMIC_SWITCHING, then you must also set the CBRQueryDynamicThreshold property.

In dynamic switching mode, CBR-first behavior can be forced by CBR searches that request rank order. To maintain dynamic switching behavior, you must enable the CBRQueryRankOverride property.

You can also set this property in combination with other object store properties to force DB-first search behavior. For information about configuring the server for a particular behavior, the tradeoffs involved, and the SQL query options to override this property, see CBR Query Optimization.

Specifies rank ordering behavior for content-based retrieval (CBR) queries that request rank order. The possible values are as follows, set with a CBRQueryRankOverride value.

• DISABLED (0 or null). This setting applies to CBR searches that combine both a full text query and a relational search on a database (DB), and when the CBRQueryOptimization property is set to DYNAMIC_SWITCHING.

  In dynamic switching mode and for a search requesting rank order, the server can only calculate results in rank order when the search is performed content first (CBR-first search). It is not possible for the server to perform the search database first (DB-first search) with rank order calculated.

  This setting forces CBR-first only searches for combined queries that request rank order. The server will not perform DB-first searches if rank order is requested. If you want results to always be ordered by rank, set this property to DISABLED.

• ENABLED (1). This setting applies to CBR searches that combine both a full text query and a relational search on a database (DB), and when the CBRQueryOptimization property is set to DYNAMIC_SWITCHING.

  For optimized execution of combined searches that request rank order, set this property to ENABLED. The server will dynamically switch between CBR first and DB first, and will return CBR-first searches in rank order. The server will suppress the request for rank order if dynamic switching chooses a DB-first search.

• REQUIRED (2). This setting suppresses a request for rank order for all CBR searches, with or without dynamic switching enabled, including CBR-first searches.

  With dynamic switching and a setting of REQUIRED, the server will dynamically switch between CBR first and DB first, and it will suppress the request for rank order for both DB-first and CBR-first searches. Removing all rank ordering can help performance, especially for searches running against multiple collections.

For more information, see CBR Query Optimization.

The type of content-based retrieval (CBR) search engine enabled for the object store. Call the ObjectStore.get_CBRSearchType method to retrieve the value. If CBR is not enabled for the object store, the returned value is NONE. Otherwise, the value identifies the currently configured search engine. (See the related constants in com.filenet.api.constants.CBRSearchType.)

This property is not supported.

Specifies the maximum size of text to be retained in the text index from which to generate a summary.

This property is not supported.

Specifies the maximum size of summary text to be returned in a text search result.

This property is not supported.

Defines the type of summary text to be available in text search results.

A collection of change preprocessor actions associated with an ObjectStore object.

Specifies a ChoiceListSet object containing the set of ChoiceList objects defined in this object store.

Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

Specifies a ClassDescriptionSet object, which contains a collection of the ClassDescription objects associated with a given object store. The ClassDescriptions property returns a "snapshot" of the latest class metadata for a given object store. If you make changes to a class, it will not be reflected in the ClassDescriptions collection until you refresh the object store.

Specifies the frequency of recording updates to the DateContentLastAccessed property (that is, the time of the last content access). Recording frequency can be none, immediate, hourly, or daily.

Note Enabling content access recording (that is, setting to an option other than "None") impacts system performance. The more frequent the updates to the DateContentLastAccessed property, the greater the impact is to the system.

The DateContentLastAccessed property on a document or annotation is updated based on the value of a given object store's ContentAccessRecordingLevel property. The update occurs whenever content on a ContentTransfer object on the document or annotation is accessed. Content on a ContentTransfer object is considered accessed when:

• "Content" is included in the property filter of a document or annotation during refresh. For example:

  doc.refresh(new String[] {PropertyNames.DATE_CONTENT_LAST_ACCESSED, PropertyNames.ID, 
  "Content", PropertyNames.CONTENT_ELEMENTS});

  
  In this case, the DateContentLastAccessed property is updated during the refresh.
• "Content" is not included in the property filter, but Document.accessContentStream is called to retrieve the content. For example:

  doc.refresh(new String[] {PropertyNames.DATE_CONTENT_LAST_ACCESSED, PropertyNames.ID, 
  PropertyNames.CONTENT_ELEMENTS});

  
  In this case, the DateContentLastAccessed property is updated during the content access operation (via the accessContentStream method).

Note that even if the content is larger than the specified chunk size (default or user-specified) and multiple trips to the database or cache are performed, the DateContentLastAccessed property is set to the time when the content is first accessed.

Indicates the name of the user assigned as the creator of the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Defines the database connection attributes used by this object. Set this property to a CmDatabaseConnection object, which defines the data sources to be used by the object. For database connection sharing, set the same CmDatabaseConnection object on all object stores, event export stores, and isolated regions that will share the same database.

For an isolated region, if the ObjectStore property is set, then the server automatically sets this property and the DatabaseSchemaName property to the same values as the object store's properties of the same name. You cannot change the object store-derived values on this or the DatabaseSchemaName property.

If the isolated region is used by IBM Case Manager, you must set the ObjectStore property. For an isolated region that uses a legacy workflow system, set DatabaseConnection and DatabaseSchemaName to values that reference the legacy system.

Specifies the location within the database in which index information is to be created and referenced. If this property is set during creation of the object store, Content Engine uses the value to control where indexes are located. A change to the property value after the object store is created affects only the location of indexes that are added after the change. You can override the value of this property by specifying a custom schema script during object store creation. See Factory.ObjectStore.createInstance(domain, admins, users, schemaScript).

Specifies the location within the database in which Large Object (LOB) data is to be created and referenced. If this property is set during creation of the object store, Content Engine uses the value to control where LOB data is placed. A change to the property value after the object store is created affects only the location of LOBs that are added after the change. You can override the value of this property by specifying a custom schema script during object store creation. See Factory.ObjectStore.createInstance(domain, admins, users, schemaScript).

Note This property is ignored on DB2 for z/OS.

Specifies the name of the schema in which the tables and indexes for an object store, isolated region, or event export store reside. The value serves as a qualified name for the database entities.

A unique value is required for database connection sharing. Database connection sharing is initiated when two or more objects are configured to use the same CmDatabaseConnection object.

To distinguish between identically named tables associated with multiple objects that share a database connection, enter a unique, case-insensitive value. The value cannot duplicate the DatabaseSchemaName value of another object using the same database connection. The value will be prepended to database entities, for example, <schema name>.<table name>.

If you do not set a value for an object store, the object store is initialized using the default schema applied by the database server, and this property is set to that default schema name provided it is not already in use by another object store using the same CmDatabaseConnection object.

For an isolated region, if the ObjectStore property is set, then the server automatically sets this property and the DatabaseConnection property to the same values as the object store's properties of the same name. You cannot change the object store-derived values on this or the DatabaseConnection property.

If the isolated region is used by IBM Case Manager, you must set the ObjectStore property. For an isolated region that uses a legacy workflow system, set DatabaseConnection and DatabaseSchemaName to values that reference the legacy system.

Specifies the location within the database in which new tables are to be created and referenced. If this property is set during creation of the object store, Content Engine uses the value to control where tables are located. A change to the property value after the object store is created affects only the location of tables that are added after the change. You can override the value of this property by specifying a custom schema script during object store creation. See Factory.ObjectStore.createInstance(domain, admins, users, schemaScript).

Note This property is ignored on DB2 for z/OS.

Specifies the database type (DB2, MSSQL, or ORACLE).

For ObjectStore, this property is deprecated. Use CmDatabaseConnection.DatabaseType.

Indicates the date and time the object was created. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Indicates the date and time the object was last modified. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

The default value (in seconds) for the maximum amount of time that the server allows a query to run before canceling the query. This property, in conjunction with the MaxQueryTimeLimit property and the SQL TIMELIMIT option , limit a Content Engine search for a client-to-server RPC; that is, they limit the total time it takes to retrieve one page to the client. Query time limits help to prevent excessive server resource usage by a single user.

The effective time limit is the minimum of this property and the MaxQueryTimeLimit property.

The SQL Timelimit option in a query overrides DefaultQueryTimeLimit. In that case, the effective limit is the minimum of the Timelimit option and the MaxQueryTimeLimit property.

If the Timelimit option is not set, and neither property is set, the query time is unlimited.

In addition to the time limits that impact client-to-server RPCs, you can set the QueryDatabaseTimeout property, which limits query execution at the database level.

For more information, see Server Query-Timeout Behavior.

Specifies a ReservationType constant that indicates, if an explicit choice is not made when a document is checked out, the default type of reservation to create (collaborative or exclusive) in this object store. For a newly created object store, this property is initialized to EXCLUSIVE.

The DefaultReservationType property can have one of the following values:

• COLLABORATIVE: Indicates a collaborative reservation, which is a reservation that any user with the appropriate permissions can check in, modify, or delete.
• EXCLUSIVE: Indicates an exclusive reservation, which is a reservation that only the user who checked out the document can check in, modify, or delete.

User-readable text that describes an object.

The text is not locale-specific to the retrieving user except for the following classes:

• ClassDescription
• PropertyDescription
• ClassDefinition
• PropertyTemplate
• PropertyDefinition

The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.

For CmAuditProcessingBookmark and AuditDefinition objects, this property is intended to identify client applications that process the audit log. For CmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object. For AuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality.

For CmAuditProcessingBookmark and AuditDefinition objects, it is recommended that you set this property. Specify a unique value to distinguish one client application from another. Note, however, that the server does not prevent identical display names across multiple CmAuditProcessingBookmark or AuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness.

Specifies a DocumentClassificationActionSet object that contains the collection of DocumentClassificationAction objects that have been created in this object store. Each DocumentClassificationAction object represents Java™ code for auto-classifying documents that hold a particular type of content data.

Specifies a DocumentLifecycleActionSet object that contains the collection of DocumentLifecycleAction objects defined in this object store.

Specifies a DocumentLifecyclePolicySet object that contains the collection of DocumentLifecyclePolicy objects associated with this object store or DocumentLifecycleAction object.

The FileNet P8 domain to which a given object belongs.

A collection of the the EventAction objects associated with an ObjectStore object.

Deprecated.

The maximum number of milliseconds difference (delta) in the timestamps (age) of entries in the cache to allow for age equality of the entries. This value is used by the cache-purging algorithm associated with FolderCacheReapFrequency.

Folder entries that have this number of milliseconds or less difference in their timestamps will be considered equal, for the purposes of comparison when determining which entries to purge from the cache.

The maximum number of folders in the folder cache for the object store. Each object store has only one folder cache. The folder cache is incrementally added to as queries are made of the cache to find folders. As requests are made of the folder cache for information, that information is read from the object store. The folder information is then stored in the folder cache and returned to the caller.

Deprecated.

The frequency with which the folder cache is to be purged when the cache exceeds the value of FolderCacheMaxEntries. A usage algorithm determines which folder entries are to be removed. Folder entries are removed from the cache until the number of entries in the cache is less than or equal to the value of FolderCacheMaxEntries.

The value for this property indicates that, whenever the cache exceeds the value of FolderCacheMaxEntries, n (the value specified) entries can be added to the cache before the purging algorithm will run.

Determines whether searches operate in case-insensitive mode regardless of the configured behavior of the database.

The default number of rows that can be returned from the indexing data during a search. This value can be exceeded using the FULLTEXTROWLIMIT option for a SQL statement. As this value is increased, the amount of system resources used in a full text search operation goes up, as does the time to execute a full text search that results in a large number of hits. As this value is decreased, the accuracy of full text searches may be reduced.

The maximum number of rows that can be returned from the indexing data during a search. If the FULLTEXTROWLIMIT option is specified for a SQL statement, the lesser of this property value and the value specified for FULLTEXTROWLIMIT is used as the maximum number of rows that can be returned.

Setting this limit prevents excessive resource use during a search operation. If not changed by the system administrator, the value of this property defaults to infinity.

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.

The IndexArea objects that can be used to store full-text indexing information for this object store.

Indicates whether or how indexing failures are persisted to the object store.

Represents the collection of IsolatedRegion objects associated with a FileNet P8 domain or a database connection.

Specifies the Java™ Naming and Directory Interface (JNDI) name of the non-XA data source defined in the Java™ Platform Enterprise Edition (Java EE) application server.

For ObjectStore, this property is deprecated.

Specifies the Java™ Naming and Directory Interface (JNDI) name of the XA data source defined in the Java™ Platform Enterprise Edition (Java EE) application server.

For ObjectStore, this property is deprecated.

Indicates the name of the user who last modified this object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Indicates the name of the locale in which this object is currently operating. A locale name is an ID that indicates the specific regional language of the text string value of a display name or description. For example, the ID "en-us" or "en_US" indicates United States English. Note that the locale name formats are those supported in IETF RFC-3066, with the addition of support for using underscores (_) in place of hyphens between the regional language and the country code, as shown in the example above. Setting the locale to "C" is also supported, and simply maps to the server's Java™ Virtual Machine (JVM) defaults for language and country. Variant information passed in the country code of the locale string is ignored by the Content Engine validation routines and stripped off when the object is saved to the object store. Locale validation logic applies to both the Java UserContext locale-specific operations as well as the WSDL-defined locale for the web services SOAP transport.

The names of the locales this object supports. Each locale name is a string containing an ID that indicates the specific regional language of the text string value of a display name or description.

The maximum amount of time (in seconds) that the server allows a query to run before canceling the query. This property, in conjunction with the DefaultQueryTimeLimit property and the SQL TIMELIMIT option, limit a Content Engine search for a client-to-server RPC; that is, they limit the total time it takes to retrieve one page to the client.

The effective time limit is the minimum of this property and the SQL Timelimit option. If the SQL Timelimit option is not set, the effective time limit is the minimum of this property and the DefaultQueryTimeLimit property.

If the Timelimit option is not set, and neither property is set, the query time is unlimited.

In addition to the time limits that impact client-to-server RPCs, you can set the QueryDatabaseTimeout property, which limits query execution at the database level.

For more information, see Server Query-Timeout Behavior.

The name for this object.

For most classes, this property is read-only and returns the value of the designated name property for the object, or its ID if there is no name property. If ClassDescription.NamePropertyIndex has a value, this property contains the value of the designated name property. If there is no designated name property value, and the object has an Id property, this property contains the string value of the Id property. If neither of these conditions is satisfied, this property contains an empty string.

For a ComponentRelationship object, this property is read/write and specifies the name of the object.

Specifies the Time-To-Live (TTL) in seconds for entries in the object security cache. Once the TTL has elapsed, cached information that has become stale is discarded and fresh data is obtained from the database.

For more information about this cache, see Security Caching.

Specifies the maximum number of entries in the object security cache. When the maximum number is exceeded, the least recently used elements are removed to allow more recently used elements to be cached.

For more information about this cache, see Security Caching.

Specifies the persistent ID (GUID) that identifies the given object store.

A list of CmTextSearchPartitionProperty objects, each of which represents a Content Engine object property that has been selected to act as an IBM® Content Search Services index partition constraint for this object store. This list can contain a maximum of one CmTextSearchPartitionDateProperty object, representing a custom date-valued index partition constraint property, and one CmTextSearchPartitionStringProperty object, representing a custom string-valued index partition constraint property. Both properties must have a settability of SETTABLE_ONLY_ON_CREATE.

Manages the discretionary permissions assigned to the object.

An enumeration of CmPolicyControlledSweep objects related to this object store.

Specifies a PropertyTemplateSet object that contains the defined property templates in this object store.

The timeout in seconds applied only to JDBC database query execution during an ad hoc search. (For SQL Server only, this property also applies during fetching.)

You can set this property to the following values:

• Null - No time limit is applied.
• 0 (zero) - No time limit is applied.
• N - An integer from 0 (zero) to Integer.Max_Value.

If this property is set, the effective time limit for each JDBC statement execution is the smaller of any remaining RPC time limit at the time the statement is executed and the QueryDatabaseTimeout value.

This property provides additional control over long-running searches that consume database resources for too long, such as LIKE %value% queries that cause table scans, or complex join queries.

To determine an effective setting for this property, you must take into consideration the time limit for the client-to-server RPC, as set on the DefaultQueryTimeLimit property. The total client-to-server RPC time is composed of the time to parse the Content Engine (CE) SQL into database (DB) SQL, execute the DB SQL, fetch the rows from the database, and check security for each row found. In addition, for a content-based retrieval (CBR) search, the time also includes the full-text search time. Finally, with a paged search, where a fixed amount of rows (typically twice the pagesize) is retrieved from the database at a time, the entire process of DB SQL execution and fetching is repeated if the initial rowset doesn't fill the client page. This can be due to either security filtering or when the initial set of CBR hits do not match the database property criteria.

So as an example, if you were to set the total RPC time limit to 10 minutes, all of the steps described above for the client-to-server search must complete within 10 minutes. At the same time, you could set the QueryDatabaseTimeout value to 30 seconds to specifically limit the DB SQL execution time, because database resource issues (such as blocking) can occur in a smaller time frame.

The typical use-cases of setting a large RPC timeout include long running CBR searches, or non-paged searches that return a large rowset. The typical use-cases for setting QueryDatabaseTimeout is to keep table scans or complex joins from running too long in the database.

The right choices for the RPC timeout and QueryDatabaseTimeout involve considerations from both the P8 Administrator and DBA.

For more information, see Server Query-Timeout Behavior.

An enumeration of CmQueueSweep objects related to this object store.

Specifies a ClassDefinitionSet object containing the set of root class definitions (objects instantiated from ClassDefinition and its subclasses) that are defined in this object store. Each class definition defines the set of mutable metadata (including property definitions) for a given class. Once you have set a reference to collection returned by the RootClassDefinitions property, you can access all of the mutable class metadata available in this object store.

The automatically-created Folder object representing the root of the container hierarchy associated with this object store

Specifies the current version string corresponding to the ObjectStore's database schema.

Specifies the maximum number of entries allowed in the security descriptor cache for a given object store. When the maximum number is exceeded, the least recently used security descriptor elements are removed to allow more recently used elements to be cached.

Specifies a SecurityPolicySet object that contains a collection of the security policies associated with this ObjectStore object.

Identifies the site associated with a given object. A site represents a geographical area in the FileNet P8 domain. If you do not specify a site when creating the associated object, the value of that object's Site property defaults to the value of Domain.DefaultSite.

Note that you cannot change the site directly on an ObjectStore object. To move an object store to a different site, you must change this property on the CmDatabaseConnection object that is referenced by the ObjectStore object.

For IsolatedRegion, this property is deprecated.

Specifies the collection of all storage areas.

For a storage policy, this represents all storage areas (regardless of the ResourceStatus property value) that the policy references (the filter includes).

Specifies a StoragePolicySet object that contains a collection of storage policies associated with an object store.

The maximum number of subscribed events to store in the subscription cache. Caching is only used if the total number of subscribed events is less than or equal to this setting. If the number is larger than this setting, caching is not used for the object store.

To disable the subscription cache, set this property to zero.

A collection of the subscriptions associated with this object.

An enumeration of CmSweepJob objects related to this object store.

An enumeration of CmSweepPolicy objects related to this object store.

The programmatic identifier for this class description, class definition, property description, property definition, property template, or object store. The value of the property is treated in a case-insensitive manner.

For objects in which you can set the SymbolicName property (object store, class definition, and property template objects), the value of the SymbolicName property must begin with a letter and contain the following characters only: 'A' to 'Z', 'a' to 'z', '0' to '9', and '_' (underscore). No blanks or symbols are allowed. If you do not provide a value for the SymbolicName property, the server will generate it, based on the value of the DisplayName property, when you save the object. For class definition and property template objects, avoid assigning its symbolic name to a value beginning with one of the reserved prefixes: Cm, Dita, and RM.

For object store objects, the symbolic name for an object store must be unique within a domain.

For class definition objects, the symbolic name for a class must be unique within an object store.

For property template objects, the symbolic name for a property must be unique within a class family only. A class family is defined by a root class (for example, Document, Folder, or CustomObject) and all of its descendants. Changing the symbolic name of a property template for a string-valued property that has been enabled for full-text indexing (IsCBREnabled property set to true) will require re-indexing of all objects containing that property. If you do not re-index, full-text searches on this property will fail to find any objects.

The collection of TableDefinition objects used by the object store. This collection represents all of the database tables used by the Content Engine.

Applies to DB2 only. Indicates whether overflow tables can be created or not. If table overflow support is enabled, Content Engine creates an overflow table if the row-size limit of a base DB2 table is exceeded. The default value is false.

Enabling table overflow support could slightly degrade database performance. It is recommended that you first consider metadata design options before enabling this support.

Species whether this object store is enabled for IBM® Content Search Services (true) or not (false).

Deprecated.
A language code that specifies the default language to use for indexing documents on this object store. Because this property has been deprecated, refrain from using it in new applications; use the TextSearchIndexingLanguages property instead. When you set the TextSearchIndexingLanguages property, the Content Engine server sets the TextSearchIndexingLanguage property to the default language code that is specified by the TextSearchIndexingLanguages property, which is the first language code in its string list.

A string list of one or more supported language codes, each of which specifies a language of the documents that are to be indexed on the object store. If the IBM® Content Search Services server cannot determine the language of a document to be indexed in an index request, the first language code in the string list is used as the default language code for the index request.

Ensure that the languages that you specify with this property match the languages of most of the documents in this object store; otherwise, you might experience a performance delay. If you do not set this property to at least one language code, and the deprecated TextSearchIndexingLanguage property has not been previously set, an error will occur during indexing.

The TextSearchIndexingLanguages property can specify one or more of the language codes in the following table.

Language code	Language
af	Afrikaans
ar	Arabic
ca	Catalan
zh	Chinese
cs	Czech
da	Danish
nl	Dutch
en	English
fi	Finnish
fr	French
de	German
el	Greek
he	Hebrew
it	Italian
ja	Japanese
ko	Korean
nb	Norwegian (Bokmal)
nn	Norwegian (Nynorsk)
pl	Polish
pt	Portuguese
ru	Russian
es	Spanish
sv	Swedish

A FolderSet collection object containing the directly-contained Folder objects that are the starting points (children of the root folder) in the container hierarchy.

Deprecated.
For an ObjectStore object, the VerityDomainConfiguration object that contains the IBM Legacy Content Search Engine configuration properties for a Verity domain. The configuration determines the Verity domain used by the object store. More than one object store can share the same Verity domain configuration.

For a Domain object, this property is deprecated. Use this property on an ObjectStore object to assign a Verity domain configuration to an object store.

Deprecated.
The length of time in months that each Verity collection will span for partitioning. Used in conjunction with the VerityPartitionProperty Property, VerityPartitionInterval determines the values of the StartDate Property and the EndDate Property of each partitioned collection, and the collections into which documents with a date/time property are indexed.

Time intervals span integral numbers of months, without spanning year-end boundaries. The possible values are null, 0, 1, 2, 3, 4, 6, or 12. A value of 1 generates collections spanning one-month intervals, a value of 2 generates collections spanning two-month intervals, and so on. For example, if the date associated with an indexable document is December 15th, 2008, and VerityPartitionInterval is 3 months, then the document would be indexed in the collection with a start date of October 1, 2008 and a stop date of January 1, 2009.

The default is null, indicating that the partitioning feature is disabled. A value of 0 also disables the partitioning feature. Setting a value other than those listed above results in an E_BAD_VALUE exception. You can change the VerityPartitionProperty property value after the ObjectStore object has been created.

Deprecated.
The symbolic name of a date/time property to be used for partitioning documents into Verity collections. When this property is set, documents, annotations, folders, and custom objects that are enabled for CBR, and that contain a date/time property that matches the value of VerityPartitionProperty, are indexed in Verity collections based on the date ranges of the collections. For example, assume that there is an email class with a property named "receivedDate". If the value of the VerityPartitionProperty is set to "receivedDate", then partitioned Verity collections are created, and a document of the email class will be indexed into the Verity collection with the date range corresponding to the receivedDate value of the document. For information on how date ranges are established for Verity collections, see the VerityPartitionInterval Property.

The property affects all index areas configured on the object store. The default is null, indicating that the partitioning feature is disabled.

A WorkflowDefinitionSet object that contains the WorkflowDefinition objects associated with this object store.

Specifies an XMLPropertyMappingScriptSet object containing the collection of XMLPropertyMappingScript objects associated with this object store or DocumentClassDefinition object. Each XMLPropertyMappingScript object holds a property-mapping XSL script that is registered for XML documents of a specific type. This script extracts content from XML documents and maps it to property values associated with a particular document class.

For DocumentClassDefinition objects, this property specifies the set of XMLPropertyMappingScript objects that have specified this DocumentClassDefinition object as the value of their TargetClass property.