Public Properties
Name | Description | |||||
---|---|---|---|---|---|---|
![]() |
AddOnInstallationRecords | Specifies a list of objects corresponding to this object store. |
||||
![]() |
AuditLevel | 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 object. |
||||
![]() |
CBRLocale | The Verity locale used for the object store. Any valid locale name supported by Verity can be used. This value must be set before any objects are created, and may not be modified while any 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. |
||||
![]() |
ChoiceLists | Specifies a object containing the set of objects defined in this object store. |
||||
![]() |
ClassDescriptions | Specifies a object, which contains a collection of the objects associated with a given object store. The 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 collection until you refresh the object store. |
||||
![]() |
ContentAccessRecordingLevel | Specifies the frequency of recording updates to the property (that is, the time of the last content access). Recording frequency can be none, immediate, hourly, or daily.
The
|
||||
![]() |
DatabaseIndexStorageLocation | 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. | ||||
![]() |
DatabaseLOBStorageLocation | 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. Note: This property is ignored on DB2 for z/OS. |
||||
![]() |
DatabaseTableStorageLocation | 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. Note: This property is ignored on DB2 for z/OS. |
||||
![]() |
DatabaseType | Specifies the database type (DB2, MSSQL, or ORACLE). | ||||
![]() |
DefaultQueryTimeLimit | The default value (in seconds) for the maximum amount of time that the server will allow a query to run before cancelling the query. This value can be overridden by a query. | ||||
![]() |
DefaultReservationType | Specifies a 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 . A collaborative reservation is a reservation that any user with the appropriate permissions can check in, modify, or delete. An exclusive reservation is a reservation that only the reservation owner can check in, modify, or delete. |
||||
![]() |
DescriptiveText | User-readable text that describes an object. The text is not locale-specific to the retrieving user except for the following classes:
|
||||
![]() |
DocumentClassificationActions | Specifies a object that contains the collection of objects that have been created in this object store. Each object represents Java code for auto-classifying documents that hold a particular type of content data. |
||||
![]() |
DocumentLifecycleActions | Specifies a object that contains the collection of objects defined in this object store. |
||||
![]() |
DocumentLifecyclePolicies | Specifies a object that contains the collection of objects associated with this object store or object. |
||||
![]() |
Domain | The FileNet P8 domain to which a given object belongs. | ||||
![]() |
EventActions | A collection of the the objects associated with an object. |
||||
![]() |
FolderCacheMaxAgeDelta |
Obsolete.
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 . 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. |
||||
![]() |
FolderCacheMaxEntries | 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. | ||||
![]() |
FolderCacheReapFrequency |
Obsolete.
The frequency with which the folder cache is to be purged when the cache exceeds the value of . 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 . The value for this property indicates that, whenever the cache exceeds the value of |
||||
![]() |
ForceCaseInsensitiveSearch | Determines whether searches operate in case-insensitive mode regardless of the configured behavior of the database. | ||||
![]() |
FullTextRowDefault | The default number of rows that can be returned from the indexing data during a search. This value can be exceeded using the 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. |
||||
![]() |
FullTextRowMax | The maximum number of rows that can be returned from the indexing data during a search. If the option is specified for a SQL statement, the lesser of this property value and the value specified for is used as the maximum number of rows that can be returned. This limit prevents excessive resource use during a search operation. |
||||
![]() |
IndexAreas | The objects that can be used to store full-text indexing information for this object store. |
||||
![]() |
JNDIDataSource | Specifies the Java Naming and Directory Interface (JNDI) name of the DataSource defined in the Java 2 Platform Enterprise Edition (J2EE) application server, which can be used to access the object store database via a non-XA database connection. | ||||
![]() |
JNDIXADataSource | Specifies the Java Naming and Directory Interface (JNDI) name of the DataSource defined in the Java 2 Platform Enterprise Edition (J2EE) application server, which can be used to access the object store database via an XA database connection. | ||||
![]() |
LocaleName | 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 UserContext locale-specific operations as well as the WSDL-defined locale for the web services SOAP transport. | ||||
![]() |
LocaleNames | 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. | ||||
![]() |
MaxQueryTimeLimit | The maximum amount of time (in seconds) that the server will allow a query to run before canceling the query. This cannot be overridden by an individual query. Setting this value helps to prevent excessive server resource usage by a single user. |
||||
![]() |
Name | 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 For a |
||||
![]() |
ObjectSecurityCacheEntryTTL | 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. |
||||
![]() |
ObjectSecurityCacheMaxEntries | 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. |
||||
![]() |
ObjectStoreId | Returns the persistent ID (GUID) that identifies the given object store. | ||||
![]() |
Permissions | Manages the discretionary permissions assigned to the object. | ||||
![]() |
PropertyTemplates | Specifies a object that contains the defined property templates in this object store. |
||||
![]() |
RootClassDefinitions | Specifies a object containing the set of root class definitions (objects instantiated from 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 property, you can access all of the mutable class metadata available in this object store. |
||||
![]() |
RootFolder | The automatically-created object representing the root of the container hierarchy associated with this object store |
||||
![]() |
SecurityDescCacheMaxEntries | 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. | ||||
![]() |
SecurityPolicies | Specifies a object that contains a collection of the security policies associated with this object. |
||||
![]() |
StorageAreas | 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). |
||||
![]() |
StoragePolicies | Specifies an object that contains a collection of storage policies associated with an object store. |
||||
![]() |
Subscriptions | A collection of the subscriptions associated with this object. | ||||
![]() |
SymbolicName | Represents 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 For property template objects, changing the symbolic name of a property template for a string-valued property that has been enabled for full-text indexing ( |
||||
![]() |
TableDefinitions | The collection of objects used by the object store. This collection represents all of the database tables used by the Content Engine. |
||||
![]() |
TopFolders | A collection object containing the directly-contained objects that are the starting points (children of the root folder) in the container hierarchy. |
||||
![]() |
WorkflowDefinitions | A IWorkflowDefinitionSet object that contains the IWorkflowDefinition objects associated with this object store. | ||||
![]() |
XMLPropertyMappingScripts | Specifies an object containing the collection of objects associated with this object store or object. Each 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 |