ObjectStore Properties

This topic alphabetically lists the properties that apply to the ObjectStore class.

AddOnInstallationRecords Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  LIST
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  AddOnInstallationRecord
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

AuditLevel Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  0
PropertyMaximumInteger32:  1
PropertyMinimumInteger32:  0
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

CBRLocale Property

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 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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  32
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

ChoiceLists Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  ChoiceList
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

ClassDescription Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  true
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  ClassDescription
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

ClassDescriptions Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  ClassDescription
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

ContentAccessRecordingLevel Property

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:

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  null
PropertyMaximumInteger32:  86400
PropertyMinimumInteger32:  -1
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

Creator Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
MaximumLengthString:  80
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  SETTABLE_ONLY_ON_CREATE
TargetAccessRequired:  READ

DatabaseIndexStorageLocation Property

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).

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  128
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

DatabaseLOBStorageLocation Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  128
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

DatabaseTableStorageLocation Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  128
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

DatabaseType Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  null
PropertyMaximumInteger32:  null
PropertyMinimumInteger32:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

DateCreated Property

Indicates the date and time the object was created. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  DATE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

DateLastModified Property

Indicates the date and time the object was last modified. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

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).

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  DATE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

DefaultQueryTimeLimit Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  null
PropertyMaximumInteger32:  null
PropertyMinimumInteger32:  null
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

DefaultReservationType Property

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:

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  null
PropertyMaximumInteger32:  32
PropertyMinimumInteger32:  16
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

DescriptiveText Property

User-readable text that describes an object.

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

DisplayName Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

DocumentClassificationActions Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  DocumentClassificationAction
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

DocumentLifecycleActions Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  DocumentLifecycleAction
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

DocumentLifecyclePolicies Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  DocumentLifecyclePolicy
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

Domain Property

The FileNet P8 domain to which a given object belongs.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  Domain
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

EventActions Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  EventAction
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

FolderCacheMaxAgeDelta Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  0
PropertyMaximumInteger32:  0x7FFFFFFF
PropertyMinimumInteger32:  none
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

FolderCacheMaxEntries Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  8192
PropertyMaximumInteger32:  none
PropertyMinimumInteger32:  1024
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

FolderCacheReapFrequency Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  0
PropertyMaximumInteger32:  0x7FFFFFFF
PropertyMinimumInteger32:  none
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

ForceCaseInsensitiveSearch Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  null
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

FullTextRowDefault Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  null
PropertyMaximumInteger32:  null
PropertyMinimumInteger32:  null
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

FullTextRowMax Property

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.

This limit prevents excessive resource use during a search operation.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  null
PropertyMaximumInteger32:  null
PropertyMinimumInteger32:  null
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

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:

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

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  GUID
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

IndexAreas Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  IndexArea
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

JNDIDataSource Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  64
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

JNDIXADataSource Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  64
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

LastModifier Property

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).

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  false
MaximumLengthString:  80
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

LocaleName Property

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 underbars in placed of hyphens between the regional language and the country code, as show 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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

LocaleNames Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  LIST
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

MaxQueryTimeLimit Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  null
PropertyMaximumInteger32:  null
PropertyMinimumInteger32:  null
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

Name Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  true
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

ObjectSecurityCacheEntryTTL Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  600
PropertyMaximumInteger32:  0x7FFFFFFF
PropertyMinimumInteger32:  none
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

ObjectSecurityCacheMaxEntries Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  8192
PropertyMaximumInteger32:  0x7FFFFFFF
PropertyMinimumInteger32:  none
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

ObjectStoreId Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  GUID
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

Permissions Property

Manages the discretionary permissions assigned to the object.

Metadata

AllowsDefaultChange:  false
Cardinality:  LIST
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  true
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  DiscretionaryPermission
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

PropertyTemplates Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  PropertyTemplate
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

RootClassDefinitions Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  ClassDefinition
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

RootFolder Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  Container
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

SecurityDescCacheMaxEntries Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
PropertyDefaultInteger32:  8192
PropertyMaximumInteger32:  none
PropertyMinimumInteger32:  256
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

SecurityPolicies Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  SecurityPolicy
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

Site Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  Site
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

StorageAreas Property

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).

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  StorageArea
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

StoragePolicies Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  StoragePolicy
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

Subscriptions Property

A collection of the subscriptions associated with this object.

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  Subscription
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

SymbolicName Property

Represents the programmatic identifier for this class description, class definition, property description, property definition, property template, or object store.

For objects in which you can set the SymbolicName property (object store, class definition, and property template), 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 property template objects, 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.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_WRITE
TargetAccessRequired:  READ

TableDefinitions Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  TableDefinition
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

TopFolders Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  Container
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

WorkflowDefinitions Property

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

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  WorkflowDefinition
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

XMLPropertyMappingScripts Property

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.

Metadata

AllowsDefaultChange:  false
Cardinality:  ENUM
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
ReflectiveProperty:  null
RequiredClass:  XMLPropertyMappingScript
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ