Properties

Specifies the trace flags applied to the classes in the API subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.

The number of seconds between cleanups of the inbound directory. The inbound directory is one of the temporary locations where content is stored during the first stage of content upload. A cleanup deletes those files considered abandoned; specifically, those files that have not been committed and are not participating in an existing transaction.

This property works in conjunction with the TempFileLifetime property to determine which files get deleted as part of a periodic cleanup.

The frequency (in seconds) with which database tables containing temporary content will be scrubbed to eliminate abandoned content. Abandoned content is content not participating in an existing transaction and not committed as part of a previous transaction.

This property works in conjunction with the TempDBContentLifetime property to determine which temporary content gets deleted as part of a periodic cleanup.

The frequency (in seconds) with which abandoned thumbnail-generation temporary files are removed from the system.

A bitmask combining bit values representing the security access rights granted on a given object. The property behavior is as follows:

• On an AccessPermission, the access rights are granted on a given object to the grantee specified on the access permission.
• On an AccessPermissionDescription, the access rights are those that may be granted on a given object.

Indicates the security access type (Allow or Deny) that a user has for a given AccessPermission object.

Specifies the DNS site name listed under the Active Directory container. For each site, set the value of this property to one DNS site under the Active Directory container "CN=Sites,CN=Configuration,DC=...".

Each FileNet P8 Site instance can be mapped to no specific DNS site or exactly one DNS site. If more than one site is configured for the FileNet P8 domain, and these sites are in different geographical locations, LDAP communication between the application server and the directory server might go across a WAN and performance might suffer. To alleviate this, you can set this property, which causes the API to search for all domain controllers for the given domain under that site. For example, you could set the value of this property to "Chicago". All domain controllers for the given domain under "CN=Chicago,CN=Sites,CN=Configuration,DC=..." are tested by attempting a connection. The first running domain controller is selected.

The list of ActiveMarking objects currently applied to a given object. Each ActiveMarking object represents a marking that is in a MarkingSet associated with a property on the object.

Specifies the add-on associated with this installation record.

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

Specifies the name of the add-on associated with this installation record.

Specifies whether the addon is optional or recommended for installation into an object store. During object store creation, Administration Console for Content Platform Engine selects for installation those addons having a type of recommended. Therefore, you should define an addon as recommended only if the functionality it provides is very likely to be required in most installations. The majority of addons should be defined as optional and must be explicitly selected for installation. Note that although the default Administration Console behavior is to install recommended addons, this is not required; you can deselect a recommended addon if you do not need the functionality it provides.

Specifies the add-ons (including upgrade add-ons) registered with a domain.

A CmTextSearchAffinityGroup object representing the affinity group with which the IBM® Content Search Services server or IBM Content Search Services index area is associated. An affinity group is a group of one or more servers that is dedicated to one or more index areas. Assigning IBM Content Search Services servers and index areas to affinity groups allow you to override the built-in index load-balancing feature of the Content Engine server.

A ReplicationDirection constant that specifies the direction in which mapping applies for this class or property alias: inbound, outbound, or both.

Specifies an IdList object containing a list of optional alias IDs for this class definition, property definition, or property template. Depending on the type of object to which it belongs, an alias ID is set equal to the PrimaryId of another property definition, the Id of another property template, or the Id of another class definition in another object store to equate the two properties or classes as being the same entity in multiple object store searches (see the SearchScope class).

A collection of all Realm objects for the EntireNetwork object.

A boolean that specifies whether an Active Directory configuration can use an email address or User Principal Name (UPN) as the user short name.

If the value of this property is false, the Active Directory security provider parses login user names (principal names) to determine if the name is in UPN format, meaning that it contains an @ character followed by at least one dot character (for example, jsmith@mydomain.com). If the principal name is in UPN format, it is assumed to take the form name@domain, where name is the user name and domain is the name of an Active Directory domain configured in Administration Console for Content Platform Engine. This special handling can be useful in some large Active Directory forest and domain setups, but prevents email addresses and certain UPNs from being used as the user short name.

If the value of this property is true, the Active Directory security provider does not parse the principal name, which allows email addresses and UPNs to be used as the user short name. Setting this property to true implies that ReturnNameAsDN is also set to true.

This property has a global effect. Therefore, it must be set the same (either all true or all false) for all Active Directory configurations defined for a Content Engine. If this property is not set the same for all configurations, the property value is implicitly false.

A flag that indicates whether or not retention on retainable objects can be reduced. If this property is false, attempts to reduce retention are ignored.

This property is settable only on the CmRetentionUpdateJob class definition. The MODIFY_RETENTION permission is required on the object store to change the property.

Specifies if and and under what condition the content data in this storage area can be cached. The property takes a CachedContentOption constant value.

Indicates whether content can be deleted from a storage area. The default is true (deletes are allowed). When false, any attempt to delete (or move) content from the storage area will result in an exception.

Specifies whether an object-valued property is permitted to reference an object in another object store (true) or not (false).

Indicates whether an application can create an object instance of a given class. If this property is false, only the Content Engine server can instantiate the class.

Indicates whether the column permits null values.

Specifies whether user-defined properties can be added to a class defined by a given class definition (true) or not (false).

Specifies whether you can create subclasses from a class defined by a given class definition (true) or not (false).

For Case Analyzer, the number of dimension rows to cache in memory for each analysis exporter. In IBM Content Foundation, Case Analyzer is not supported, and this property is ignored.

For Case Analyzer, indicates whether the analysis exporter associated with the the server hierarchy object is currently enabled. This property allows you to isolate the Case Analyzer to a particular object in the server hierarchy, for example, VirtualServer or ServerInstance. In IBM Content Foundation, Case Analyzer is not supported, and this property is ignored.

For Case Analyzer, the number of fact table rows to cache in memory for each analysis exporter. In IBM Content Foundation, Case Analyzer is not supported, and this property is ignored.

Identifies the document content element to which this annotation applies. This property is intended only as a means by which an application can match an annotation with a document content element. The server does not use it in any way other than storing the application-provided value. The application is responsible for how it interprets AnnotatedContentElement values. It is not a required property.

Because the positional index of a given content element within a document's ContentElementList collection is subject to change, it is recommended that you populate this property with the value of the content element's ElementSequenceNumber property rather than its positional index. If you instead choose to use a positional index, it is up to your application to ensure that it accurately reflects the correct index of the content element to which the annotation applies. For example, if the AnnotatedContentElement property specifies the positional index of the third content element of a document with five content elements, and the second content element is then removed, the property will consequently reference the wrong content element.

Specifies an IndependentObject object of type Document, Folder, or CustomObject to which this annotation has been applied.

Specifies an AnnotationSet object that contains the annotations associated with this object.

One or more log4j class names identifying the output destinations to use for the trace logging data. Multiple appender names are separated by commas. It is expected that the use of multiple names will be to specify a console appender and a file appender. If the class names are specified using package prefixes, the class names are interpreted absolutely; otherwise, the class names are prefixed with "org.apache.log4j" during processing. Validation of appender names occurs when they are persisted, rather than when logging is configured.

If no appender name is specified, RollingFileAppender is used by default. In this way, you need only enable the TraceLoggingEnabled property and set the appropriate fields in TraceFlags to initiate useful trace logging.

Note The error log "filenet_error" (the default) is updated to reference the configured appenders. If the base error log file is not "filenet_error", error log messages are not written to the trace logs.

The supported output destinations (class names) are as follows:

• "ConsoleAppender"

  Sends trace logging data to the default console (such as System.out).

• "FileAppender"

  Sends trace logging data to the location specified in the OutputLocation property.

• "DailyRollingFileAppender"

  A subclass of FileAppender. Backs up (rolls over) the trace logs located in the directory referenced by the OutputLocation property on a scheduled basis. The DatePattern is "yyyy-MM-dd", which initiates the backup operation daily at midnight.

• "RollingFileAppender"

  A subclass of FileAppender. The default appender used if none is specified. Backs up the trace logs located in the directory referenced by the OutputLocation property when the files exceed the maximum size.

  The default maximum trace log file size is 100MB, and the default backup index file size is 5MB. You can override these default values using the log4j command line properties "MaxRollingFileSize" and "MaxRollingFileBackups".

For more information, see org.apache.log4j.FileAppender.

Specifies the unique number identifying this IBM® Content Manager OnDemand (CMOD) application group.

Identifies the client application used to create the object.

Specifies an XML string that defines the class, properties, and security to apply to the target document. This property's value is not supplied by the caller when the request is created, but is instead based on the parameters specified in the publish options and publish template at the time the request is submitted (it provides a snap-shot of the relevant properties and security that is to be applied to the publication document).

Unique identifier for the version state to which a given security template applies. For a VersioningSecurityTemplate, the state can be one of the following:

• VersionStatusId.IN_PROCESS
• VersionStatusId.RELEASED
• VersionStatusId.RESERVATION
• VersionStatusId.SUPERSEDED

For an ApplicationSecurityTemplate, the state is defined by your application.

Specifies whether to apply the permissions associated with the security template to a given object on transition to a given document state.

For internal use only. The type of the asynchronous upgrade.

Specifies the trace flags applied to the classes in the Asynchronous Processing subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.

This property is not currently supported.

This property is not currently supported.

This property is not currently supported.

This property is not currently supported.

References a PropertyTemplate that represents an individual property to be audited in a class. An audited source property in a class is mapped to an event property in an audit record of the Event table. By default, AuditAs is set to null.

Custom properties can be audited by setting PropertyDefinition.AuditAs to an existing PropertyTemplate, which typically is the same object from which the PropertyDefinition was created. However, system properties do not have pre-existing property templates, so you must create a new property template for a system property that you want to audit. For code examples, see Configuring Property Auditing.

AuditAs is settable on a PropertyDefinition as long as that PropertyDefinition does not already inherit an AuditAs value. Once set, its value is automatically inherited as read-only in subclasses. If the PropertyDefinition referenced by an AuditAs property is deleted, then that AuditAs property becomes settable on all immediate subclasses. For example, if root class A has a property P that is audited, and also has immediate subclasses A1 and A2, then P on A1 and P on A2 (referred to as P1 and P2) are inherited, with the same AuditAs value as set on A.P. If A.P is deleted, P1 and P2 get promoted to non-inherited properties on A1 and A2, respectively. As non-inherited properties, P1 and P2 now have AuditAs values that can be modified to point to a different property, independently of each other.

On PropertyDescription, AuditAs is read only.

A list of the AuditDefinition objects that shows the events to be audited for this class.

Indicates the size of batch used for deletion of audited events that are ready for disposition. Enter a value between 10 and 1000 inclusive. The default is 100.

Indicates whether or not audit disposition processing is enabled. The default is false.

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

Indicates the number of records selected for deletion that satisfy an object store's disposition policy rules and its lowest-valued audit bookmark. Enter a value between 1 and 1000 inclusive. The default is 100. For more efficient dispostion of audit records, enter a value that's at least the size of AuditDispositionBatchSize.

A list of CmTimeslot objects, with each object specifying a weekday, start time, and duration for audit disposition to run.

Specifies the trace flags for controlling audit disposition logging. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.

Indicates the number of seconds the audit disposition thread waits to check if an unexpired timeslot exists to begin the disposition process. The minimum value is 10 seconds. The default value is 30 seconds.

A boolean value that indicates whether auditing for failed event operations is enabled (true) or not (false). Currently, auditable failures are limited to an access-denied result of an operation.

NOTE If all audit definitions for a class specify that neither failed nor successful operations should be logged, then auditing for the class is effectively disabled.

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.

A boolean value that indicates whether auditing for successful event operations is enabled (true) or not (false).

NOTE If all audit definitions for a class specify that neither failed nor successful operations should be logged, then auditing for the class is effectively disabled.

Specifies a prefix string to use when deleting a C-Clip using the audited delete function for a CenteraFixedContentDevice object. If the string is blank, audited delete will not be invoked (FPClip.Delete will be used). Otherwise, the string will be used as the prefix of the delete reason passed to FPClip.AuditedDelete (the document ID GUID is appended to the prefix string to form the complete delete reason text).

An EventSet collection of the Event objects containing the audited events that have occurred for the object.

The IDs of the base classes associated with this CmTextSearchIndex object.

The symbolic name of a date property defined on the class specified by the sweep target, for example, DateCreated or DateModified. The date property specified is a base date that is used with the RetentionDurationUpdate and RetenionPeriodUnits properties to compute a new retention date on the retainable objects. The BaseDatePropertyName property can be set only when the SpecificRetentionDate property is not set.

The server computes the new retention date by adding the value of the RetentionDurationUpdate property, expressed in the units specified by the RetentionPeriodUnits property, to the value of the date property specified by the BaseDatePropertyName property.

If the AllowRetentionReduction property is set to true, you can use the BaseDatePropertyName property to reduce retention. Set the BaseDatePropertyName property to a date property other than the CmRetentionDate property. Then set the RetentionDurationUpdate and RetenionPeriodUnits properties so that the new retention date computes to a value that is less than the current CmRetentionDate property value of the retainable objects.

Specifies the time in milliseconds that an Import Agent waits between batches when processing batch requests.

Attention: Do not change the value of this property without guidance from a support representative. Doing so might adversely affect system performance.

The maximum number of batches that are selected by the import agent dispatcher from the database in a single database round trip.

Specifies the maximum buffer size used to determine if the entire content blob should be read with a single call to FPTag.BlobRead. If the content size is less than or equal to the parameter value, the entire blob is read using a single call (a buffer of content size must be allocated), and the data is passed back via the callers data stream as requested. If the content size is greater than the parameter value, FPTag.BlobReadPartial is used to read only the data of the size requested by the caller (no buffer is created).

Specifies the collision avoidance option for a CenteraFixedContentDevice object. When creating Centera content, the provider combines this value with FP_OPTION_CLIENT_CALCID_STREAMING to form the options parameter of FPTag.BlobWrite. There are three possible values:

• 0: Use the collision avoidance scheme of the Centera system.
• 64: Override system setting, enable collision avoidance (FP_OPTION_ENABLE_COLLISION_AVOIDANCE).
• 128: Override system setting, disable collision avoidance (FP_OPTION_DISABLE_COLLISION_AVOIDANCE).

Deprecated.
The service port number used to access this isolated region.

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.

Specifies the trace flags applied to the classes in the CBR (Content-Based Retrieval) subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.

Specifies the trace flags applied to the classes in the CFS Daemon (Content Federation System) subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.

Trace flags corresponding to the CFS Import Agent subsystem. This value consists of a combination of TraceFlag constants.

For an external (non-FileNet P8) repository, the UTF-8 encoded, non-encrypted password component of the credentials that the Content Federation Service (CFS) uses to log on to perform CFS functions. For more information about these credentials, including the name component, see the CFSUserName property. To maintain password security, you can use this property only to set a password, not to read its value. Instead of returning a password value, this property returns a zero-length byte array if it has been set with a password and returns a null value if it has never been set.

For an external (non-FileNet-P8) repository, the name component of the credentials that CFS uses to logon in order to perform CFS functions. (For information on specifying the password component of these credentials, see the CFSPassword property.) CFS expects these credentials to be for a security principal with the requisite security privileges. Specifically, CFS needs privileges for reading documents in order to export document metadata and content from the external repository, and privileges for changing document security permissions in order to lockdown documents. Insufficient privileges result in failures when attempting to perform these functions.

For more information on CFS interaction with an external IBM Content Integrator repository, see the IICEFixedContentDevice interface.

Specifies a CMODApplicationGroupSet object containing the set collection of application groups defined in the IBM® Content Manager OnDemand (CMOD) external repository associated with this CMOD fixed content device.

Specifies the language of the output messages from the IBM® Content Manager OnDemand (CMOD) server associated with this fixed content device.

Specifies the password for the security principal identified by the CMODUserName property.

Specifies the port number on which the IBM® Content Manager OnDemand (CMOD) server associated with this CMOD fixed content device is listening. A value of 0 indicates the default CMOD port.

Specifies the name of the IBM® Content Manager OnDemand (CMOD) server associated with this CMOD fixed content device.

Specifies the amount of trace information that will be gathered by the IBM® Content Manager OnDemand (CMOD) server associated with this fixed content device. This property can have one of the following values:

• 0: Logging not enabled.
• 1: Log error events only.
• 2: Log error and warning events only.
• 3: Log error, warning, and informational events only.
• 4: Log all events.

Specifies the name of the security principal for accessing the IBM® Content Manager OnDemand (CMOD) server associated with this CMOD fixed content device.

Specifies the NCH 3-part name of the CSM cache that is nearer to the site than the default cache. Each part of the name is separated by a colon and takes the form page_cache<n>:<domain>:<organization>. There must be no more than one local CSM cache name for a given value of <domain>:<organization>.

For example, for domain ntvaga and organization FileNet, the names are of the form page_cache<n>:ntvaga:FileNet, where <n> is an unsigned decimal integer greater than or equal to 2. The default CSM cache on the document server is page cache number 1 (for example, page_cache1:ntvaga:FileNet).

This property will be used when the Content Engine server is running within the site identified by this object's Site property.

If a FileNet Image Services fixed content device is made available across multiple sites in a FileNet P8 domain, you should create an ImageServicesSiteSettings object for each site that has a local CSM cache. This SiteSettings object will override the value of the CSMCache property for the site to enable a local CSM cache to be utilized.

The setting that enables or disables a cache area for active use. The CacheStatus class has constants defined for the cache status settings.

Valid settings are:

• OPEN (default setting): Enables the cache area for active use.
• CLOSED: Disables the cache area for active use.
• CLEARING: Disables the cache area for active use, deletes all content from the cache, initializes the values for all cache statistical properties, and automatically resets the cache status to the previous setting (OPEN or CLOSED). Once started, this cache clearing operation always completes; you cannot stop the operation or manually change the cache status from CLEARING to any other setting. In order for the clearing operation to be performed and for the cache status not to remain set to CLEARING indefinitely, at least one server must be associated with the same site as that of the content cache. For information on associating a content cache with a site, see the ContentCacheConfiguration interface.

Determines if a Site accepts forwarded requests. The value of this property is true if the Site accepts forwarded requests; otherwise, it is false (the default). The property value must be explicitly set to true when configuring the domain for request forwarding.

Request forwarding must be enabled at the site level (both for forwarding requests and for receiving forwarded requests), and each virtual server within the site must have a valid URI specified in its EJBForwardingEndPoint property to be able to receive forwarded requests.

Specifies whether a document, while in a given lifecycle state (as defined by its document lifecycle policy), can be demoted (true) or not (false). A value of true indicates that a document's lifecycle state can be changed to the previous state that is defined by its document lifecycle policy.

Determines if requests may be forwarded from a Site. The value of this property is true if the Site can forward requests; otherwise, it is false (the default). The property value must be explicitly set to true when configuring the domain for request forwarding. Note: If the value is false, no requests may be forwarded from any virtual server in the site.

Specifies a Cardinality constant, which indicates whether an object property can hold a single value (single cardinality) or a collection of multiple values (list or enumeration cardinality). You can only set the Cardinality property when you create a new property template. When you create a property definition from a property template, its Cardinality property will be automatically populated with the same value as that of the property template on which it is based. Once you have instantiated an object from the class to which the property definition belongs, the property defined by the property definition will have the specified cardinality.

For PropertyDescription and PropertyDefinition object types, this property is read-only:

• For PropertyDescriptionObject and PropertyDefinitionObject objects only, this property can have any Cardinality constant value: SINGLE, ENUM, or LIST.
• For all other PropertyDescription and PropertyDefinition object types, this property must have a value of SINGLE or LIST.

For PropertyTemplate object types, this property is settable on create:

• For PropertyTemplateObject objects only, this property must have a value of SINGLE or ENUM. You can only create a custom object-valued property that has single or enumeration cardinality; list cardinality is allowed for system object-valued properties only.
• For all other PropertyTemplate object types, this property must have a value of SINGLE or LIST.

The Cardinality property can have one of the values in the following table.

Name	Value	Description
ENUM	1	Specifies a property with enumeration cardinality. A property with enumeration cardinality is an object-valued property that returns a set collection. A set collection is a read-only collection of unique, unordered, independent objects that must be traversed sequentially. You can iterate through the items of a set collection one page of elements at a time from the server to your client application. However, if the collection changes on the server while you are iterating through it, the number, order, and values of the items in your client copy can change, even if you maintain the same reference to it. A set collection cannot hold any items other than independent objects. By contrast, a list collection can hold items of any data type, with the exception of independent objects.
LIST	2	Specifies a property with list cardinality. A property with list cardinality returns a list collection. A list collection is a collection of ordered items that can either be modifiable (allowing items to be inserted, replaced, or deleted) or read-only. These items need not be unique and can be traversed in any order. When you access a list collection from the server, a complete copy of it is created on your client application, which you can iterate through one element at a time. The items in a list collection must all be of the same data type and must match the data type of the property that returns it. If the property returning a list collection is an object-valued property, all of the objects in the list collection must be dependent objects. A list collection can hold items of any data type (provided each item is of the same data type. However, if a list collection holds objects, they must all be dependent objects; only a set collection can hold independent objects. You cannot create a custom property with list cardinality.
SINGLE	0	Specifies a property with single cardinality. A property with single cardinality returns a single value of the data type that the property can hold.

The change preprocessor action object that references the code handler to be invoked when a class instance is created or updated.

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

A list of the definition objects to configure change preprocessing on this class.

The Document object designated as the child in a component relationship. This property applies when the ComponentRelationshipType property setting is STATIC_CR, DYNAMIC_CR, or DYNAMIC_LABEL_CR. For all other component relationship types the value of this property is null. For a URI component relationship type, you designate the child component by setting the URIValue property.

For a ComponentRelationship object whose relationship type is STATIC_CR, set the value of this property to the specific document version to bind to the parent component document.

For a ComponentRelationship object whose relationship type is DYNAMIC_CR, some version of the child document must be eligible-for-binding; otherwise, calling the save method on the ComponentRelationship object throws an exception. For example, a major version of the document must exist when the version bind rule specifies only major versions can be bound. For information on the version bind rule, see VersionBindType Property. When you call the save method, the ChildComponent property is automatically updated to reflect the actual document version bound.

For a ComponentRelationship object whose relationship type is DYNAMIC_LABEL_CR, no version of the child document need be eligible-for-binding. When you call the save method, the value of the ChildComponent property is automatically updated to null or to the actual document version bound. This bound version is the most recent version of the child document satisfying the version bind rule that has a ComponentBindingLabel property value matching the LabelBindValue property value. For more information on document binding, see ComponentRelationshipType Property. Note that, when the ChildComponent property value has been updated to null, you can still determine the child document for this relationship by using the ChildVersionSeries property.

A DocumentSet collection object that contains the child Document objects bound to this parent document. The collection contains only those child documents for which the user has read access. For each ComponentRelationship object that references this document as the parent component document, the collection contains the version of the child component document that is bound to this parent document. The same child document can be in the collection more than once.

For information on the ordering of the collection, see ComponentSortOrder Property.

A ComponentRelationshipSet collection object that contains the ComponentRelationship objects referencing this document as the parent component document.

For information on the ordering of the collection, see ComponentSortOrder Property.

The VersionSeries object that is the version series of the child component document. Retrieving this property's value is equivalent to calling get_ChildComponent().get_VersionSeries(). This property applies when the ComponentRelationshipType property setting is DYNAMIC_CR or DYNAMIC_LABEL_CR; otherwise, the property value is null.

The value of a Choice object that holds an integer data type in a choice list.

Specifies a ChoiceList object that represents the discrete set of possible values that this property can hold.

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

The value of a Choice object that holds a string data type in a choice list.

Specifies a ChoiceType constant that determines the type of data that a Choice object represents: an integer-type choice item, a string-type choice item, a group node for a nested collection of integer-type Choice objects, or a group node for a nested collection of string-type Choice objects.

The ChoiceType property can have one of the values in the following table.

Name	Value	Description
INTEGER	0	Specifies a Choice object that represents an integer-type choice item.
MIDNODE_INTEGER	2	Specifies a Choice object that acts as a group node for a nested collection of integer-type Choice objects. Each Choice object in this collection must represent either an integer-type choice item or a group node for a nested collection of integer-type Choice objects.
MIDNODE_STRING	3	Specifies a Choice object that acts as a group node for a nested collection of string-type Choice objects. Each Choice object in this collection must represent either a string-type choice item or a group node for a nested collection of string-type Choice objects.
STRING	1	Specifies a Choice object that represents a string-type choice item.

A ChoiceList object representing a set of allowable values. If it is associated with a property, ChoiceValues provides a discrete set of possible values that the property can hold. Otherwise, if a ChoiceValues is associated with a Choice object, it defines the set of possible values in a choice list group.

The Class Definition of the class to be indexed. Note that you do not have to fetch the ClassDefinition to set this property; instead, call the set_ClassDefinition(Factory.ClassDefinition.getInstance) method on this IndexJobClassItem instance.

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 symbolic name of the Content Engine root class (for example, "Document") to which the class described by this external class description corresponds. This property can be null if no corresponding root class exists.

Specifies one of the following:

• The identity of the external class described by this external class description.
• The identity of the external class for which this external class alias defines a mapping.
• The identity of the external class to which this mapped property belongs.

For ExternalClassDescription objects only, this string is immutable and is unique within the repository in which the external class description belongs.

Specifies a DocClassificationStatus constant that indicates the auto-classification status for this document. The ClassificationStatus property is used to provide client applications a means of discovering whether a particular document is subject to auto-classification, and if so, whether or not the operation was successful.

This property can hold one of the following values:

• CLASSIFICATION_COMPLETE: Indicates that document auto-classification has completed successfully.
• CLASSIFICATION_FAILED: Indicates that document auto-classification has failed.
• CLASSIFICATION_PENDING: Indicates that a request for document auto-classification is pending. This value is set automatically by the server when you check in a document and set the checkin method's autoClassify parameter to AUTO_CLASSIFY.
• NOT_CLASSIFIED: Indicates that document auto-classification has not been requested. This value is set automatically by the server when you check in a document and set the checkin method's autoClassify parameter to DO_NOT_AUTO_CLASSIFY.

Specifies the date and time when the storage area will close and no longer accept new content.

Indicates the relative (ascending) order this event was audited relative to other audited events. Used for audit disposition, the property is retrieved by an audit processing client to set the sequence number of the last record processed on the client's CmAuditProcessingBookmark object.

Specifies whether content in this storage area should be compressed. Content compression reduces the space consumed in a storage area of any type, but there are performance tradeoffs in using it. For more information, see Content compression.

If you enable content compression, you can modify default operation settings with the CmCompressionThresholdPercent and CompressionBlockSize properties.

Specifies as a percentage of the original size the minimum to which the first block of a content stream must be compressed in order for the entire stream to be compressed. For example, for a compression ratio of 80%, the entire data stream will be compressed if the first block of uploaded data, when compressed, is 80% or less of the original uncompressed size.

Some data formats, such as JPEG and ZIP, do not compress well, and the server compression overhead might not be worth the marginal savings of storage space for such formats. This property allows you to define the threshold at which data will not be compressed. You can also define the block size of the content stream to be compressed, as set in the CompressionBlockSize property.

This property requires that content compression be turned on, as set in the CmCompressionEnabled property. For administrator-related information, see Content compression.

Indicates whether the referenced predecessor is one of a set of alternates for the successor task.

If false, the predecessor task in the relationship is required, meaning that the predecessor task must be completed before the successor task is allowed to advance. If true, the predecessor task in the relationship is not required, but rather serves as an alternate in a group of multiple alternates associated with the same successor task. If any of the alternate predecessor tasks are completed, the successor task is allowed to advance, subject to any required predecessors having also completed.

A DeviceRetentionMode constant that specifies the retention mode of this fixed storage area relative to a fixed content device. Both retention modes apply only to checked-in documents that have their content stored on a fixed content device.

This property can have one of the following values:

• ALIGNED: Specifies an alignment relative to a fixed content device. Documents checked in on a fixed storage area in aligned mode have retention enforced by both the Content Engine server and the fixed content device. In this mode, the fixed content device must support the retention period specified by the value of the CmRetentionDate property of the document, or else the operation fails. If the source location of the content data of a document is on a fixed content device that is under aligned mode, the content data can only be deleted or moved if the retention period of the document has expired.
• NOT_ALIGNED: Specifies no alignment relative to a fixed content device. In this mode, retention is enforced by the Content Engine server only.

An enumeration of CmHoldRelationship objects associated with this object.

A bitmask of IndexingFailureCode constants that identify the types of indexing failures that have occurred as a result of an index request for a CBR-enabled object. If there are no indexing failures, the CmIndexingFailureCode property returns a value of zero.

If you set the value of the IndexingFailureRecordingLevel property of an ObjectStore object to PROPAGATE_TO_SOURCE, the error information is propagated to the CmIndexingFailureCode property of all CBR-enabled objects.

Indicates whether permissions should be inherited from the Coordinator property.

Indicates whether the object is marked (flagged) for deletion. If true, the object is the original object explicitly marked for deletion by a user, or the object is referenced by the original object through an object-valued property (OVP), and, therefore, was marked for deletion by the server.

Objects marked for deletion are represented by a CmRecoveryItem object, through which the objects can be either recovered or purged (removed from the object store database).

See Recovery Bin Concepts

The recovery item associated with this event's source object.

The retention expiration date and time of this object. This object can be deleted only after the expiration date and time has passed. If this property is null, this object is not held under retention and there are no restrictions on when it can be deleted.

When you create an object, the Content Engine server automatically sets the CmRetentionDate property to the default retention date and time. The Content Engine server calculates the default retention date and time by adding the retention period (DefaultRetentionPeriod property of the object's class definition) expressed in the selected duration units (RetentionPeriodUnits property of the object's class definition) to the date and time when the object was created. Alternatively, you can override the default value by setting the CmRetentionDate property of the object to a specific date and time. Once an object has been created, you cannot change the value of its CmRetentionDate property to a smaller value; that is, the retention period of the object cannot be shortened.

An object that has related objects under retention cannot be deleted until all of its related objects have been deleted. For example, a document with annotations cannot be deleted until all of its annotations have been deleted. The retention dates of a document and its annotations are independent of each other.

When a document is checked out, its CmRetentionDate property value is not applied to the resulting reservation object. If you set the CmRetentionDate property of the reservation object, the property value is applied to the new document version when you check in the reservation object. Note that setting the CmRetentionDate property of the reservation object does not prevent the reservation object from being deleted. If you do not set the CmRetentionDate property of the reservation object when you check it in, the CmRetentionDate property of the new document version is automatically set to the default retention date and time.

The CmRetentionDate property can be set to a specific date and time, or it can be set to one of the following RetentionConstants constants:

• INDEFINITE: Indefinite retention. Specifies that the object can be deleted only if the CmRetentionDate property is changed to an expiration date and time, and that date and time is in the past. This property can be set to INDEFINITE only if it has a value of null. If this property has been set to INDEFINITE, it cannot be set to null; it can only be set to a date and time value or to PERMANENT.
• PERMANENT: Permanent retention. Specifies that the object can never be deleted.

To set the CmRetentionDate property value on an object, you must have the following permissions:

• WRITE_ACL (modify permissions) on the object
• MODIFY_RETENTION (modify retention date) on the object store

Identifies the stored search schema version used to specify the XML query for the StoredSearch object.

The storage area from which the move content request was issued.

The priority for changing this index area from a standby index area to an open index area. The higher the value of this property, the lower the priority. The highest priority is 0, which is the default value.

When an open index areas becomes full, the Content Engine server chooses the standby index area with the highest priority and sets it to open. If two or more index areas exist with the same priority, one of these standby index areas is chosen randomly by the server.

You can control this feature by setting the JVM parameter com.filenet.engine.cbr.LegacyStandbyActivationPolicy on your application server. By default, this JVM parameter is false, which instructs the Content Engine server to open a standby index area when an index area becomes full. Set this JVM parameter to true to instruct the Content Engine server to open a standby index area only when all the index areas are either full or closed. For information about how to assign JVM parameter values for your application server, see Setting JVM parameters.

The storage area to which the move content request was issued.

Contains the set of thumbnail images corresponding to this document. Deleting the document deletes all of the thumbnails associated with it.

Indicates the transaction timeout value in seconds used during the asynchronous event handling of this event action. This property overrides the default timeout value for asynchronous processing in the GCD, set with AsyncProcessingConfiguration.get_QueueItemDatabaseTimeout. Minimum value is 30 seconds; maximum value is 3600 seconds (60 minutes).

The Java™ action handler that is executed when an Action-based object is invoked. A CodeModule object represents a user-implemented Java action handler that is checked into the Content Engine.

See Creating a CodeModule Object.

Specifies the Time-To-Live (TTL) in seconds that an entry may remain in the code module cache.

Specifies the maximum file space (in MB) to allocate for code module cache entries that overflow from memory to disk. The default value is 10 GB.

Specifies the maximum memory to allocate for code module cache entries as a percentage of the maximum memory configured for the current Java™ Virtual Machine (JVM). The default is 10%.

Specifies the trace flags applied to the classes in the Code Module subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.

The name assigned to the Verity collection.

A ColumnDefinitionList collection object containing the ColumnDefinition objects that describe the columns in the table.

The globally unique identifier (GUID) of the column in which the value of the property is stored.

The name assigned to the column.

The size of the column.

The number of sweep iterations that have occurred for a policy-controlled sweep.

The duration, in seconds, that the audit disposition background task should wait upon successful completion of a full sweep prior to initiating another. The audit disposition background task can only initiate a sweep if an unexpired timeslot exists; otherwise, it will wait for an available timeslot, so the total delay might be longer. A setting of 0 results in a full sweep as soon as the CmAuditingConfiguration.AuditDispositionWaitInterval is up (assuming an unexpired timeslot exists). The default value is 86,400 seconds (24 hours).

The setting for controlling the deletion of the child component document as an automatic response to the deletion of the parent component document. The ComponentCascadeDeleteAction class has constants defined for the component cascade delete settings.

Valid settings are:

• CASCADE_DELETE: Causes the child component document to be automatically deleted when the parent component document is deleted. Document deletion succeeds if you have delete rights (AccessRight.DELETE) for all child components involved in the cascade delete. Otherwise no component (including the parent component) can be deleted. For example, if two component relationship objects designate D1 as the parent document for D2, and D2 as the parent document for D3, and define a cascade delete relationship between D1 and D2 and also between D2 and D3, you can delete D1 only if you have delete rights for all three documents.
• NO_CASCADE_DELETE (default setting): Causes no special action to occur when the parent component document is deleted.

The setting for the delete behavior for parent and child components. The prevention settings protect a document from deletion by causing an exception to be thrown on a deletion attempt. The ComponentPreventDeleteAction class has constants defined for the component prevent delete settings.

Valid settings are:

• ALLOW_BOTH_DELETE (default setting): Allows the deletion of both the parent and child component documents.
• PREVENT_BOTH_DELETE: Prevents the deletion of both the parent and child component documents.
• PREVENT_PARENT_DELETE: Prevents the deletion of the parent component document.
• PREVENT_CHILD_DELETE: Prevents the deletion of the child component document if the parent component document exists. This setting also prevents the deletion of a parent component document if the ComponentCascadeDelete property for this ComponentRelationship object is set to CASCADE_DELETE (which deletes the child when the parent is deleted).

The setting that determines the type of component relationship between a child document and parent document. The ComponentRelationshipType class has constants defined for the relationship type settings.

Valid settings are:

• STATIC_CR (default setting): Binds the parent component version to the explicitly specified child component version. Set these required properties to create a ComponentRelationship object with this setting: ParentComponent and ChildComponent.
• DYNAMIC_CR: Binds the parent component version to the most recent child component version that satisfies the version bind rule. For information on the version bind rule, see VersionBindType Property. This setting expects an eligible-for-binding child component version to exist; for more information on this requirement, see ChildComponent Property. Set these required properties to create a ComponentRelationship object with this setting: ParentComponent, ChildComponent, and VersionBindType.
• DYNAMIC_LABEL_CR: Binds the parent component version to the most recent child component version satisfying the version bind rule that has a ComponentBindingLabel property value matching the LabelBindValue property value. No binding occurs if no such child document version exists. The value comparison considers the two properties to be matching when they have the same value, or when LabelBindValue has a null value and ComponentBindingLabel has a non-null value. For information on the version bind rule, see VersionBindType Property. Set these required properties to create a ComponentRelationship object with this setting: ParentComponent, ChildComponent, VersionBindType, and LabelBindValue.
• URICR: Creates a component relationship between the parent component document and the URI document specified by the URIValue property. The URI can be for a P8 Content Engine document, and any other "document" a URI can refer to. Set these required properties to create a ComponentRelationship object with this setting: ParentComponent and URIValue.

When you modify the ComponentRelationshipType property from one setting to another, be aware that the previously set values for some properties might be lost:

• The URIValue property applies to the URICR setting; the property value is null for all other settings.
• The ChildComponent property applies to the STATIC_CR, DYNAMIC_CR, and DYNAMIC_LABEL_CR settings; the property value is null for the URICR setting.
• The VersionBindType property applies to the DYNAMIC_CR and DYNAMIC_LABEL_CR settings; the property value is null for all other settings.
• The LabelBindType property applies to the DYNAMIC_LABEL_CR setting; the property value is null for all other settings.

For an overview of document binding, see the ComponentRelationship class.

The ascending sort order number that determines the position of this ComponentRelationship object within the ChildRelationships collection as well as the position of the child component document within the ChildDocuments collection. These collections belong to the parent component document. Relative to any other object having the same sort order number, the binary value of the ComponentRelationship object's Id property determines the ascending sort order position for this object and the associated child component.

This property cannot be set to null.

For a new ComponentRelationship object with no explicitly set component sort order, calling the save method on the object assigns a value to this property equal to the highest component sort order in the ChildRelationships collection plus 1000. For example, if you did not explicitly set the ComponentSortOrder property for any ComponentRelationship objects within the collection, the first object added to the ChildRelationships collection has a component sort order of 1000; the second, 2000; the third, 3000; and so on.

The setting that determines whether a document can be a parent component in a compound document. The CompoundDocumentState class has constants defined for the compound document state settings.

Valid settings are:

• COMPOUND_DOCUMENT: Designates the document as the parent component in a compound document. Initially, this parent document has no child components. A document must be designated as a compound document to become a parent component for a ComponentRelationship object.
• STANDARD_DOCUMENT (default setting - 4.0.x release): Designates the document as a standard document. This setting prevents the document from being a parent component within a compound document. A document cannot be designated as a standard document when referenced as a parent component by a ComponentRelationship object.
• null (default setting - 3.5.x upgraded to 4.0.x): Designates the document as a standard document. By default, pre-existing documents in an object store upgraded to 4.0.x return a null value instead of STANDARD_DOCUMENT. Note that, although a null value can be returned, you cannot set this property to null.

Specifies the maximum size of uncompressed content that will form a single block in a compressed content stream written by the server. Larger blocks will compress more effectively than smaller blocks, but will require more memory during retrieval.

This property requires that content compression be turned on, as set in the CmCompressionEnabled property. For administrator-related information, see Content compression.

Specifies the maximum number of concurrent Centera reader threads allowed in the object store service process.

Specifies the configuration parameters for a GenericFixedContentDevice object. There is no fixed format for this property (other than, it must be a string that the custom implementation of the fixed content provider can understand and parse).

This property is not currently supported.

Specifies the current state (enabled, suspended, or uninitialized) of this rendition engine connection.

Specifies the Active Directory Service provider connection timeout in milliseconds. The default is 500 milliseconds. If the connection is across a WAN, consider increasing the value.

When getting back a collection of domain controllers for a given domain, use this property in an LDAP connection request to determine if a given domain controller in the domain is up and running. If a timeout exception occurs in the specified time, assume the domain controller is not running and try the next one.

A bitmask defining the access permission associated with a given marking.

If a given user does not have the appropriate rights to perform marking-related operations on the object, the access rights specified in the marking's ConstraintMask property are removed from the user's access rights for that object.

A DocumentSet collection object containing the Document objects contained within this folder.

A ReferentialContainmentRelationshipSet collection object containing the ReferentialContainmentRelationship objects contained within this folder.

A ReferentialContainmentRelationshipSet collection object containing the ReferentialContainmentRelationship objects that identify the containers of this object.

The name of the contained object.

For a DynamicReferentialContainmentRelationship or ReferentialContainmentRelationship object, this is the name of the Head object in the relationship. The default value is supplied as follows:

• If the Head object has a MimeType property (in other words, the Head object is a Document), and if both the Name and MimeType properties of the Head object are present and not zero length, then the default value is Name.FileExtension. Content Engine maps the MIME type of the Head object to a file extension based on the mimetypes.properties file to determine FileExtension. If an apparent file extension is already present in the value of the Name property, then the default is the Name value of the Head object (no FileExtension is appended). If the value of the MimeType property does not map to any file extension, then no FileExtension is appended. In all cases, invalid characters (see list below) are removed from the Name value, and the Name value is truncated to 255 characters.
• If the MimeType property value is not present, the default is the Name value of the Head object. Invalid characters are removed from the Name value, and the Name value is truncated to 255 characters.
• If the Name value is not found, the Id value of the Head object is used.

The following characters are not allowed:

    \  /  :  *  ?  "  <  >  | 

For an Event object generated from the FileEvent and UnfileEvent classes, the value of this property is the name of the Containable object that was added or removed, respectively.

In the following scenarios, the server looks for naming collisions and makes the containment name unique:

• If AutoUniqueName.AUTO_UNIQUE is set when the object is filed. This setting should be used with caution, as described in Class AutoUniqueName.
• If an object that is filed in a folder is marked for deletion, the server modifies the containment name in any relationship objects referenced by the object marked for deletion. This is done to prevent a collision with any new object filed into the same folder, using the same containment name. If the object is later restored, the server attempts to change the containment names back to their original values (before the object was marked for deletion). For more information about marking objects for deletion, see Recovery Bin Concepts.

If a naming collision is detected when AutoUniqueName.AUTO_UNIQUE is set, or when an object that's marked for deletion object is restored, the server resolves the conflict by appending a unique suffix to the the containment name, as follows:

• The server first iterates a set of serial integers to create a unique name with a parenthesized number, such as "myDocument(14)".
• If a unique name is still not found, the server appends a tilde followed by five random characters to the containment name, such as "myDocument~Ae7Hq".

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.

The configured content cache area. This file storage area stores duplicates of the document content most frequently requested, and permits those duplicates to be accessed in lieu of the originals in order to enhance the document retrieval performance of local servers. For more information on the content cache area, see the ContentCacheArea interface.

A collection of all ContentCacheArea objects associated with the FileNet P8 domain.

Specifies the trace flags applied to the classes in the Content Cache subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.

The number of content elements stored in this storage area.

For a ContentCacheArea object, this property returns null when the server cannot physically access the cache storage area and the CacheStatus property setting is Closed. Also, this statistic, along with the statistic concerning content element size (the ContentElementKBytes property), can become inaccurate as the result of power failures; properly timed failures will prevent servers from keeping the statistics in perfect sync with content creations and deletions. A cache sweep updates the statistics every 60 days to keep them reasonably accurate.

The size of all content elements stored in this storage area (in kilobytes). If content compression is turned on for a StorageArea object, this property reflects the compressed size of the content.

For the ContentCacheArea object, this property returns null when the server cannot physically access the cache storage area and the CacheStatus property setting is Closed. Also, this statistic can become inaccurate; for more information, see the ContentElementCount property.

Specifies a ContentElementList object containing the list of content elements associated with this document or annotation. Each content element represents content data, which can either be local to an object store and stored in a file store or database (represented by a ContentTransfer object) or external to an object store and therefore outside the control of the Content Engine server (represented by a ContentReference object).

Total content elements created in a Storage Area.

The number of content elements deleted from this storage area.

For the ContentCacheArea object, a cache clearing operation initializes this number to 0 (zero). For information on cache clearing, see the CacheStatus property. For information on the potential inaccuracy of this number, see the ContentCacheArea class.

Specifies a StringList object containing the MIME type of each content element associated with this document or annotation at the time it was last saved.

Specifies, in URL format, the name of the resource that contains the content data represented by this ContentReference object.

The maximum number of workers that can exist simultaneously per object store. The primary function of the workers is to carry out the second stage of the content upload process. Workers process work from the content queue in batches of one or more queue items.

Specifies the date until which this checked-in document must be retained, as determined by the content storage subsystem. This document can be deleted only after this date has passed.

This property is maintained for backward compatibility and is automatically populated by the server with the same value as the document’s CmRetentionDate property.

Specifies the size in bytes of the content data associated with this document, annotation, or ContentTransfer object. Note that if the document or annotation has more than one content element, then the size is the sum of all of the content elements.

Specifies the trace flags applied to the classes in the Content Storage subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.

Represents a document's content summary.

When performing a full-text (CBR) search, avoid referencing the ContentSummary column. The retrieval of this text column can slow the execution of the search.

The root of the directory structure that holds temporary content. Specify a fully qualified location for the root directory local to the server, such as a mount point (/mount/root) or drive (c:\data\root), and give the server exclusive permissions to access the root directory. The server must have sufficient permissions to create subdirectories; it creates the inbound directory off of this root directory.

When the value for this property is null, the server uses the FileNet working directory as the directory root for temporary content.

Specifies the Multipurpose Internet Mail Extensions (MIME) format string of the content data carried by this content element, indicating the kind of data this content element represents. MIME is a communications protocol that allows for the transmission of data in many forms, such as audio, binary, or video.

You can set the ContentType property of a specific content element when you create it and attach it to a document version. The ContentType property requires a value. If you do not provide a value for the ContentType property of a ContentReference object, an error occurs. By contrast, if you do not provide a value for the ContentType property of a ContentTransfer object, the Content Platform Engine attempts to discover the MIME type of the content data, and automatically sets the property to an estimated MIME type value. However, it is not always possible for the Content Platform Engine to make a correct determination of the content data that the ContentTransfer object holds. Therefore, IBM recommends that you always set this property to the correct MIME type value when you add the content element. At a minimum, if you do not specify the MIME type value of the ContentType property, ensure that the path specified by the RetrievalName property of the ContentTransfer object contains the correct filename extension for the type of content data.

Although the Content Platform Engine does not enforce the format of this property's value, a MIME format string consists of a content type, a content subtype, and an optional parameter in the following format: "content type/subtype[;parameter]", for example, "text/html". Interpretation of the value is up to retrieving applications.

MIME defines the following content types:

• text: Represent textual information in a number of character sets. A charset parameter may be used ("text/plain;charset=us-ascii", for example). Some subtypes: plain, html, richtext.
• image: Represents still images. Some subtypes: jpeg, gif.
• audio: Represents audio or voice data. Some subtypes: wav, au.
• video: Represents video data or moving-image data. Some subtypes: mpeg, mp4.
• message: Encapsulates an entire formatted message. Some subtypes: rfc822, partial, external-body.
• multipart: Combines several body parts of potentially different types and subtypes. Some subtypes: mixed, alternative, parallel, digest.
• application: Represents application data (such as executables) or binary data.

The following MIME types are specific to FileNet:

• application/x-filenet-declarerecordtemplate: Record template.
• application/x-filenet-external: An object that contains a single ContentReference content element.
• application/x-filenet-external-is: External Image Services document.
• application/x-filenet-publishtemplate: Publish template.
• application/x-filenet-scenariodefinition: Scenario definition document.
• application/x-filenet-search: Stored search.
• application/x-filenet-searchtemplate: Search template.
• application/x-filenet-workflowdefinition: Workflow definition document.

The sweep policy or job that incurred the failure.

The enumeration of tasks coordinated by the Containable object. Each CmTask object in the enumeration represents a single piece of work in a business process. A CmTask object with a Coordinator property set to this Containable object is added to the enumeration value of this property.

A reference to the Containable object that is acting as the coordinator for this and other related tasks. To return an enumeration of all related tasks coordinated by the object, call Containable.get_CoordinatedTasks.

A value indicating whether some particular document feature gets passed on as a default feature for the next document version. The passed-on feature can be a property value or a component relationship. When the CopyToReservation property value is true, source document checkout causes the source feature to be replicated for the newly created document reservation object.

For a PropertyDefinition object, a value indicating whether the value of the property defined by this property definition should be copied, during checkout, from the source document to the newly created reservation object. For a PropertyDescription object, CopyToReservation is read only.

For a ComponentRelationship object, a value indicating whether this object gets copied, during checkout of the parent component source document, for the newly created reservation object. The reservation object becomes the parent component for the new copy of this ComponentRelationship object. Consequently, both the reservation object and the source document have an equivalent component relationship with the same child document. Note that the reservation object behaves like any other document with respect to compound document properties and relationships.

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.

The number of objects that were examined during the current sweep iteration of an ongoing sweep.

The number of objects for which the processing failed during the current sweep iteration of an ongoing sweep.

The ID of the IBM® Content Search Services server that is assigned to use this IBM Content Search Services index. If the assigned IBM Content Search Services server becomes unavailable, the Content Engine server automatically chooses another server to assign to this index.

The number of objects that were processed during the current sweep iteration of an ongoing sweep.

Specifies the name of the current lifecycle state of this document as defined by its document lifecycle policy. Each document lifecycle policy defines a set of states through which a document can transition into during its lifecycle. This property is equal to the value of the StateName property of the DocumentState object representing the current lifecycle state of this document.

The current user. The current user is the user under whose credentials RPCs are being performed. When returned within an asynchronous event handler, the current user is the one who triggered the event, and not the user in the JAAS security context.

Specifies a document version that represents the latest checked-in version associated with this document or version series. The current version can be either a major version or a minor version.

Specifies the database transaction timeout in seconds for DITA-specific publishing requests.

Specifies the fully qualified path to the directory where the DITA Open Toolkit is installed. The path can be a local mount point, a local path, or a UNC path.

Specifies optional Java Virtual Machine (JVM) arguments that will be used to invoke the DITA Open Toolkit when publishing DITA content. For example, if you are publishing a large DITA information set, you can specify additional JVM memory by setting the value of this property to -Xmx512m.

Contains a reference to the DITARenditionEngineConnection object used by this publishing configuration.

Contains a reference to the DITARenditionEngineConnectionSet object that lists the DITA Rendition Engine connections for this domain.

Specifies the fully qualified path to the working directory where DITA component documents will be downloaded from the Content Engine for publishing via the DITA Open Toolkit. The path can be a local mount point, a local path, or a UNC path.

Deprecated.
The DNS (Domain Name System) name of the Process Engine server used to access this isolated region.

Specifies a TypeID constant, which indicates the data type of the value that an object can hold.

For PropertyDescription, PropertyDefinition, and PropertyTemplate objects, this property is read-only and specifies the data type of the value that an object property can hold. Because the value of the DataType property is automatically set by the Content Engine server to correspond to the specific object type of the PropertyDescription, PropertyDefinition, or PropertyTemplate object, you do not need to set it when you are creating a property template or property definition. For example, in a PropertyDescriptionBinary, PropertyDefinitionBinary, or PropertyTemplateBinary object, the server automatically sets the DataType property to a value of BINARY.

For ChoiceList objects, this property is settable on create and must be a LONG or STRING constant value. This property determines whether a choice list is an integer-type choice list, which holds integer-type choice items or a string-type choice list, which holds string-type choice items.

For ColumnDefinition objects, this property is read-only and specifies the data type of the object property value that is stored in the represented database table column.

For CmIndexPartitionConstraint objects, this property is read-only and specifies the data type of an index partition constraint. Only the following values are valid:

• DATE: Specifies a date index partition constraint.
• STRING: Specifies a string index partition constraint.

The DataType property can have one of the values in the following table.

Name	Value	Description
BINARY	1	Specifies a binary data type. Represents binary data by using an array of unsigned 8-bit bytes.
BOOLEAN	2	Specifies a Boolean data type. Represents Boolean data having a value of true or false.
DATE	3	Specifies a DateTime data type. Represents an instance in time as a date and time of day in accordance with ISO 8601.
DOUBLE	4	Specifies a double (Float64) data type. Represents an IEEE-standard 64-bit floating-point number, which has a value ranging from -1.79769313486232e308 to +1.79769313486232e308.
GUID	5	Specifies a GUID (ID) data type. Represents a Globally Unique Identifier (GUID) or DCE Universally Unique Identifier (UUID), which is a unique 128-bit number, as a string of 32 hexadecimal characters enclosed by brackets in the following format: {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.
LONG	6	Specifies an integer data type. Represents a signed 32-bit integer, which has a value ranging from -2,147, 483,648 to +2,147,483,647.
OBJECT	7	Specifies an object data type. Represents an object that is instantiated from a Content Engine class.
STRING	8	Specifies a string data type. Represents text consisting of a sequential collection of 16-bit Unicode characters.

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.

An enumeration of database connections associated with this domain.

Deprecated.
Reserved for future use.

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 database to which the Rendition Engine connection is made.

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 name of the host for the database to which the Rendition Engine connection is made.

Specifies the port number for a database server connection.

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 trace flags applied to the classes in the Database subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.

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

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

Specifies the date and time that this document was checked in. The Content Engine stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

The server sets this property on a document version when it is checked in and it remains set throughout the life of the document version. When a document is checked out, the server sets this property on the document's reservation object to null.

Settability of this property is read-only for most users. Users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE) can set this property on a document while it is being checked in. Note that although the settability of this property for users with privileged write access is SETTABLE_ONLY_BEFORE_CHECKIN, those users can not set this property on a document prior to check in; it can be set only while a document is being checked in.

The date and time at which the task transitioned into the COMPLETE state.

Specifies the date and time when the content data (represented by a ContentTransfer object) associated with this document or annotation was last accessed. The Content Engine stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

The recording granularity of the date and time returned by this property is determined by the setting of the object store's ContentAccessRecordingLevel property. The content data associated with a document or annotation object is considered to be accessed when one of the following events occur:

• An object's refresh method is called with the property filter set to refresh PropertyContent properties (FilteredPropertyType.CONTENT_DATA).
• An object's accessContentStream method is called to retrieve content data in an input stream.

Each of these events will update the date of the DateContentLastAccessed property. Note that even if the content data is larger than the user-specified chunk size and multiple trips to the database or cache are required, the DateContentLastAccessed property will be set only to the date and time that the content data was first accessed. Applications that access content data frequently will cause continual updates of the DateContentLastAccessed property by the server, which can result in degraded performance. Therefore, it is recommended that you set the ContentAccessRecordingLevel property to control the frequency that the DateContentLastAccessed property is updated.

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

Indicates the date and time of the index request.

The date and time at which the task transitioned into the WORKING state.

The default length of time in seconds between the end of one sweep pass and the beginning of the next one.

Specifies the name of the Image Services (IS) document class that controls native content. The IS document class definition has default values that control the IS document content security and media family where the content will be stored.

The default security owner for an object of a given class. This property is useful if you want a group or user other than the object's creator to have owner security rights.

A list of descriptions of default permissions to be used when creating an instance of a given class.

The default discretionary permissions to be used when creating an instance of a given class.

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.

Specifies the default retention period. A positive value represents the number of days the content element must be retained. Other possible values are:

• 0: No minimum retention period (content may be deleted at any time).
• -1: Infinite retention period (content can never be deleted).
• -2: Same retention period as the associated fixed content device. (For FixedStorageArea objects only.)
• -101: Reserved for internal use only.
• -102: Retention period is not supported. This is the default if no RetentionPeriod value has been defined for the storage area.

Specifies whether the retention period is set to the current Centera system setting (true) or not (false). This flag only applies when a fixed storage area's retention period is configured to use the retention period of the fixed content device (that is, when the fixed storage area's RetentionPeriod property is set to -2). Normally the provider will examine the value of the FP_RETENTION pool capability and explicitly set the retention period to either zero or infinite, depending on the capability setting. When DefaultRetentionPassThrough is set to 1, the retention period is set to RETENTION_PERIOD_DEFAULT (meaning that the Clips use the current Centera system setting, which can be altered by changing the compliance mode of the system).

The duration of the default retention period for the class defined by this class definition. The time unit (days, for example) in which the value of the DefaultRetentionPeriod property is expressed is determined by the value of the RetentionPeriodUnits property. For a new instance of the class defined by this class definition, the Content Engine server calculates the default retention date and time of the instance by adding the retention duration, expressed in the specified period units, to the date and time when the instance is created. The CmRetentionDate property of the instance is initially set to the default retention date and time, unless it is overridden.

Instead of a retention period, the DefaultRetentionPeriod property can be set to one of the following RetentionConstants constants:

• INDEFINITE: Indefinite retention period. Specifies that the instance of the class defined by this class definition can only be deleted if its CmRetentionDate property has been converted to a expiration date and time and that date and time is in the past.
• PERMANENT: Permanent retention period. Specifies that the instance of the class defined by this class definition can never be deleted.

Identifies the default geographical site associated with the FileNet P8 domain. The value of this property is initialized to "Initial Site" when the Content Engine server is initialized and the GCD is created. Initial Site is a system-generated instance of the Site class that holds the Virtual Server (and thus, Server Instance) of the current application server instance. A user with system administrator rights can subsequently assign a different site to be the default, if desired.

If you do not specify a site when creating a site-related object (such as an ObjectStore object), the created object's Site property is set to the value of the DefaultSite property.

The setting that specifies the deletion method for content in this storage area. The AreaDeleteMethod class has constants defined for the deletion method settings.

Valid settings are:

• DESTRUCTIVE: Specifies that content be overwritten once with zeros before it is deleted.
• PURGE: Specifies that content be overwritten three times before it is deleted. This is the most secure form of delete.
• STANDARD (default setting): Specifies that content be deleted using the normal delete operation for the given device or file system.

Specifies the action to be taken with respect to a given object-valued property when an attempt is made to delete the object that contains the property. The value of this property can specify that a cascading delete action be taken on all objects referenced by the property (for example, if you delete a document, the Content Engine automatically deletes all of the annotations associated with it); or that the deletion action be prevented (for example, the Content Engine will not allow you to delete a folder until all of its associated sub-folders are deleted); or that no special action be taken during a delete (for example, the Content Engine will not prevent you from deleting an annotation that is associated with a document).

Specifies a DocumentSet collection object that contains all of the publication documents to which this document is the owner document.

Specifies the host name of the server responsible for dequeuing the item. Note that a retried queue item might have a different DequeueHost value for each retry, depending on which server actually processed the queue item.

Specifies a string that describes this object.

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

Specifies a LocalizedStringList object containing a collection of LocalizedString objects, each of which represents a locale-specific, user-readable description of a class or property.

Specifies documents that are publications of this document. This property is a reflective property of the SourceDocument property.

The destination repository for the source object of the replication operation that generates this journal entry.

Specifies an IP address or fully qualified domain name.

Password associated with a fixed content device.

This property is not currently supported.

Specifies the absolute path to the SnapLock volume used to store content (from the perspective of the SnapLock device). The path starts from the volume name (for example, /snap_volume/v16) and corresponds to the same physical location that is referenced by the RootDirectoryPath property, which is the path as viewed from the Content Engine server.

A DirectoryConfigurationList object that specifies the collection of directory server configurations for a given FileNet P8 domain. This collection represents the type-specific directory server configurations for the supported directory servers (Microsoft Active Directory, ADAM, CA eTrust, IBM Tivoli, Novell eDirectory, Oracle Internet Directory (OID), and Oracle Directory Server) that will be queried by the Content Engine server when authorizing user and group names for login.

Identifies the LDAP directory server or servers to use. See also the DirectoryServerPort property.

The value of this property can be any one of the following:

• Single host name, single IP address (all LDAP directory types)
  When the value is a host name and a single IP, Content Engine attempts to connect to the directory server that runs on that host. Content Engine uses the port number specified by the DirectoryServerPort property for this connection attempt.
• Single host name, multiple IP addresses (Microsoft® Active Directory and IBM® Tivoli® Directory Server)
  You can manually create DNS address records ("A" records) to assign the same host name to each of the different IP addresses. Failover using multiple IP addresses can be specified only when the value of the DirectoryServerType property is AD (Active Directory) or IBM (Tivoli Directory Server).

  The benefit of using multiple IP addresses for failover is that you do not need to modify a failover list when you change the host name, or when you decommission a domain controller or Tivoli Directory Server. In addition, this option is useful when the Active Directory domain contains remote domain controllers but you want to connect only to local DCs (as opposed to using the "Domain name" option below). The DC connection attempts are done in parallel. The first successful connection is the DC used.

• Domain name (Microsoft Active Directory)
  When the value is an Active Directory domain name and the value of the DirectoryServerType property is AD (Active Directory), Content Engine attempts to connect to any domain controller (DC) in the specified domain. Each DC must use the same LDAP port numbers (generally the case). The DC connection attempts are done in parallel. The first successful connection is the DC used.
• Failover list (Microsoft Active Directory and IBM® Tivoli® Directory Server)
  When the value is a list of host names paired with port numbers, Content Engine attempts to connect to one of the directory servers represented in the list. (The DirectoryServerPort property is ignored.) A failover list can be specified only when the value of the DirectoryServerType property is AD (Active Directory) or IBM (Tivoli Directory Server). For Active Directory, each directory server represented in the failover list is expected to be a DC.

  Format the failover list in the following manner:

          Hostname1:Port1 Hostname2:Port2 Hostname3:Port3 ... HostnameN:PortN

  Separate the host name and port number pairs with one space character. In the following example, the first pair specifies LaurelTree as the machine name and 389 as the port number:

          LaurelTree:389 OliveTree:636 FigTree:389

  Content Engine makes connection attempts to directory servers based on the order of the pairs in the list. The connection attempts stop when Content Engine either successfully connects to a directory server or exhausts the list. The connection attempts resume at the beginning of the list when Content Engine loses a previously established directory server connection.

  For instance, given the example list, Content Engine first attempts to connect to the directory server on the LaurelTree machine on port 389. If that attempt fails, it attempts to connect to the directory server on the OliveTree machine on port 636. If that attempt succeeds, the connection attempts stop. If, later on, Content Engine loses the connection to the directory server on OliveTree, the connection attempts start over again with LaurelTree.

The UTF-8 encoded, non-encrypted user password for authenticating to a given directory server. To maintain password security, you can use this property only to set a password, not to read its value. Instead of returning a password value, this property returns a zero-length byte array if it has been set with a password and returns a null value if it has never been set.

The port number of the directory server.

Content Engine ignores this property when the value of the DirectoryServerHost property is a failover list. For information about failover lists, see the DirectoryServerHost property.

Specifies the directory server provider class name. The value of this property defaults to the following strings for the directory server types that the FileNet® P8 Content Engine supports:

• com.filenet.engine.security.ActiveDirectoryProvider (for Microsoft® Active Directory®)
• com.filenet.engine.security.IBMTivoliProvider (for IBM® Tivoli®)
• com.filenet.engine.security.EDirectoryProvider (for Novell eDirectory)
• com.filenet.engine.security.SunOneProvider (for Oracle Directory Server (formerly SunOne))
• com.filenet.engine.security.OIDProvider (for Oracle Internet Directory)

The type of directory server for the directory server configuration. The value for this property is one of the following:

• AD (for Microsoft® Active Directory®)
• ADAM (for Microsoft® Active Directory Application Mode) (Windows 2003) and for Microsoft® Active Directory Lightweight Directory Services (Windows 2008))
• IBM (for IBM® Tivoli® Directory Server)
• Novell (for Novell eDirectory)
• OID (for Oracle Internet Directory)
• SunOne (for Oracle Directory Server)
• CA (for Computer Associates eTrust Directory Server)
• Domino (for Domino Directory Server)
• RadiantOne (for RadiantOne Directory Server)
• VMM (for IBM Virtual Member Manager)

Specifies the user name for authenticating to the directory server. The following are examples of strings for Active Directory and Oracle Directory Server:

• For Active Directory: "CN=test1,CN=Users,DC=myCompany,DC=com"
• For Oracle Directory Server: "uid=admin,ou=administrators,ou=topologymanagement,o=netscaperoot"

The setting that determines the directory structure type for this storage area. The DirectoryStructure class has constants defined for the directory structure type settings.

Valid settings are:

• DIRECTORY_STRUCTURE_SMALL (default setting): Specifies a small directory structure. Small structures consist of two levels of directories with 23 nodes at each level (total of 529 directories at the 2nd level). Content is stored only at the 2nd level.
• DIRECTORY_STRUCTURE_LARGE: Specifies a large directory structure. Large structures extend the small structure with a third level of 23 nodes, for a total of 12,167 directories at the 3rd level. Content is stored only at the 3rd level.
• null (non-accessible content cache): For the ContentCacheArea object, this property returns null when the server cannot physically access the content cache area and has not previously done so, and the CacheStatus property setting is Closed. Note that, although a null value can be returned, you cannot set this property to null.

For the ContentCacheArea object, the directory organization of the cache permits different servers to work on different directories, and thus allows cache pruning to be scalable across multiple servers. All of the directories in the cache contain roughly the same amount of recently added content (as a result of the cache randomly selecting a directory for new content, and of pruning roughly the same amount of content from each directory). Pruning, consequently, can occur independently for each directory and yet still achieve the cache-wide result of deleting the least frequently requested content.

A boolean value that controls the run enabled status of the dispatcher. When true, the dispatcher runs. When false, the dispatcher does not run.

For the CFSImportAgentConfiguration interface, when the value of this property is true, the dispatcher runs, but the importer as a whole might still not process import requests when the import agent sub-component has not also been enabled. For more information, see the IsImportAgentEnabled property on the CFSSiteSettings interface. For a discussion of the importer sub-components, see the CFSImportAgentConfiguration interface.

The period in seconds that a thread in the dispatcher thread pool can be idle before being terminated.

Attention: Do not change the value of this property without guidance from a support representative. Doing so might adversely affect system performance.

An interval, in seconds, between processing runs for the dispatcher; during this time, the dispatcher remains idle and waits for incoming work. The value specified by this property can represent differing wait intervals depending on the class on which the property occurs, as follows:

• Except as noted below, represents a minimum wait interval, with a maximum wait interval defined by the LeaseDuration property.
• For the CFSImportAgentConfiguration interface, represents a maximum wait interval. (The minimum interval is always 1 second and cannot be changed).
• For the AsyncProcessingConfiguration interface, represents a fixed wait interval. (In effect, represents both the minimum and the maximum wait interval).

The interaction between the minimum and maximum intervals occurs in this manner: if in the previous processing run the dispatcher had work to perform, the duration of the subsequent wait interval that the dispatcher actually remains idle is the minimum interval; otherwise, if the dispatcher had no work to perform, the duration is the shorter of these two intervals: (a) Double the previous wait interval or (b) the maximum wait interval. As an example, assuming the minimum interval to be 35 seconds and the maximum as 120, the dispatcher remains idle for 35 seconds, detects no available work, remains idle for 70 seconds (double the previous wait interval), detects no available work, remains idle for 120 seconds (the maximum interval), detects no available work, remains idle for 120 seconds, detects incoming work and processes the work, remains idle for 35 seconds, and so on. Note that, when the minimal interval equals the maximum interval (as is always the case for the AsyncProcessingConfiguration interface), this example can be simplified. If both the minimum and maximum interval is 35 seconds, the dispatcher remains idle for 35 seconds, detects no available work, remains idle for 35 seconds, detects incoming work and processes the work, remains idle for 35 seconds, and so on.

For the CFSImportAgentConfiguration interface, this property, despite the name, applies to the importer sub-component known as the import agent and not to the import dispatcher; for information on the importer sub-components, see the CFSImportAgentConfiguration interface.

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 LocalizedStringList object containing a collection of LocalizedString objects, each of which represents a locale-specific, user-readable display name for a class definition, property template, or choice.

Contains the expression used to identify the audited records to delete from the Event table. A disposition rule must be a fragment of a SQL WHERE-clause expression. If the value of the expression evaluates to true, the audited event is deleted.

The disposition rule is evaluated as a filter expression, and has the same syntax requirements as the FilterExpression property.

The properties referenced in a disposition rule are relative to the event object, not to the event's source object. However, you can reference source object properties that are directly on the event object, for example, the source object class or ID. You can also reference source object properties that have been added to the event as the result of Property Auditing.

The name that uniquely identifies a given group or user. The distinguished name (DN) consists of a group or user's short name and the name of the domain to which it belongs. For example, for a group with the short name "Managers", the distinguished name might be "CN=Managers,DC=example,DC=com".

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 the DocumentLifecycleAction object associated with this DocumentLifecyclePolicy object that holds the definition of the actions to take when a document's lifecycle state changes.

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.

Specifies the DocumentLifecyclePolicy object that represents the lifecycle policy that has been applied to this document. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken when a document's lifecycle state changes.

Specifies a DocumentStateList object that contains the complete set of valid document states (each of which is represented by a DocumentState object) defined by this DocumentLifecyclePolicy object. Each document lifecycle policy defines a set of states through which a document can transition into during its lifecycle.

The base URL for the documentation that is associated with the FileNet P8 domain. The property allows clients that support context-sensitive help to retrieve the base URL from a central location, rather than each client locally storing the URL.

The property supports access of context-sensitive help built into the FileNet P8 Platform documentation. For successful retrieval of a help topic, the client must concatenate the plug-in path of the applicable topic to the base URL of the FileNet P8 Platform documentation server.

To use the FileNet P8 Platform documentation, you can link either to the online version of the information center on www.ibm.com, or to a local copy of the information center that you install and deploy.

To link to a local information center, enter the base URL in the following format:
http://server-name[:port]/application-name/topic/

where:

• server-name is the name of the server where the FileNet P8 Platform documentation information center is installed.
• port is the optional port number.
• application-name is the name of the deployed FileNet P8 documentation application.

  To install and link to a local information center, see Installing IBM FileNet P8 Platform documentation.

To link to the online information center, enter the base URL of the desired version. For example, the following URL is for the version 5.1 information center:
http://pic.dhe.ibm.com/infocenter/p8docs/v5r1m0/topic/
For a list of IBM information centers, see Product information.

The maximum number of documents placed into a batch.

The FileNet P8 domain to which a given object belongs.

Specifies the unique identifier of a domain.

Provides single instancing at the storage area level of the Content Engine. For incoming content, the property indicates whether the Content Engine should check the storage area for duplicate content. If set to true, incoming content is not added to the storage area if identical content already exists in the storage area; only unique content is added.

Consider setting this property to true for high-volume content ingestion, such as when archiving emails to a Content Engine repository. However, because this feature impacts server performance, you might want to keep the default setting if the frequency of duplicate content is low.

For the FixedStorageArea interface, you cannot set the value to true in this release.

For more information, see Content duplication suppression.

Indicates the length of time that the background task will run for a timeslot. Time is set in minutes, so a value of 60 indicates that the duration of the timeslot is one hour. Integer values of 1 and greater are allowed, but if the value is 10080 (the number of minutes in a week) or greater, the background task will run continuously.

The directory server attribute that holds the static members of a dynamic group. A dynamic group is often a hybrid group that contains both static and dynamic members. As an example, this property might identify the uniquemember attribute as that which holds the static members of the associated hybrid group.

The type of dynamic group to search, for example, dxDynamicGroupOfUniqueNames.

The attribute in the dynamic group that holds the dynamic LDAP query. An example is the dxMemberURL attribute. Content Engine server runs this query to retrieve the dynamic members of the group.

Holds the EJB forwarding URI endpoint for a VirtualServer. This property must specify a valid URI in order for the virtual servers within a site to receive forwarded requests.

A VirtualServer is the only addressable unit for forwarded requests. A VirtualServer must provide connection strings so that a remote server can connect to it. You supply this connection information in the EJBForwardingEndpoint property. If this property is empty, it is assumed that the administrator does not want the VirtualServer to accept forwarded requests. Request forwarding will not occur even if the Site is configured to accept forwarded requests via its CanAcceptForwardedRequests property.

The following are URI examples for the specified application server environments (host name can be specified as the name or IP address):

• WebLogic - "t3://Server1:7001/FileNet/Engine"
• Websphere - "iiop://Server1:2809/FileNet/Engine"
• JBoss - "jnp://Server1:1099/FileNet/Engine"

  Note: In IBM Content Foundation, JBoss is not supported.

The maximum length of the URI string is 2083 characters.

Specifies the trace flags applied to the classes in the EJB subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.

The date and time after which this sweep rule becomes no longer eligible to run. If this property is not set on a sweep policy, the policy runs continuously.

If you set this property on a sweep job, which runs one time only, be careful to allow sufficient time for the the job to process the entire table, especially if the table is very large. If the effective end date does not allow the necessary time, then the job will end before it completely processes the table.

The date and time that this sweep rule becomes effective and eligible to run. If this property is not set, then the sweep is eligible to start immediately. (It will not start immediately if, for example, the sweep is disabled, or if timeslots are set to times in the future.)

A unique sequence number for a content element in a particular document or annotation version. Server-generated, the number serves as an unchanging identity for the content element. For annotations, on which you can change content, the element sequence number for a content element will not change. For example, if you were to change a content element's relative position within the list of content elements, the element's sequence number would be retained. Or if you were to replace the first content element with updated content, the content element would receive a new element sequence number. Element sequence numbers are not reused.

This property can be accessed from a ContentElement-based object, or from GetContentEvent, representing the event fired when the content element specified in this property is retrieved.

For CmVerityIndexRequest, this property is deprecated.

Represents the user's email address. The value of this property is returned by User.get_Email().

Specifies the maximum size threshold in bytes for embedding content in the C-Clip. By default this value is zero (content is never embedded). The maximum value for this parameter is 102400 (bytes). If a greater value is supplied, it will be reduced to 102400 internally by the Centera provider. Note that this limit is per content element. The overall size of embedded data can exceed this limit if multiple content elements are embedded in a single Clip (up to the maximum size of the C-Clip).

Specifies if documents replicated to or from the external repository should be prevented from being deleted in that repository.

Indicates whether the workflow for a subscription object can be launched manually (true) or not (false).

Specifies whether content in this storage area should be encrypted.

Setting this property to true generates a new encryption key, which is used to encrypt new content. For more information on how content encryption works, see Content encryption.

Sets the key used for encrypting content in the storage area. Setting this property overrides the existing encryption key. The value of this property is not persisted, and a call to retrieve its value returns null.

This property is intended for external management of encryption keys by supporting IBM products. In general, a custom application should not use this property, unless there is a compelling reason to supply its own key rather than use a server-generated key.

An encryption key must be 128 bits in length. An incorrect length results in a E_BAD_VALUE exception. It is recommended that a Federal Information Processing Standards (FIPS) 140-compliant algorithm be used to generate an encryption key.

Note that an encryption key is used only if the EncryptionEnabled property is set to true. If the EncryptionEnabled property is set to false, the value set on this property is ignored. If the EncryptionEnabled property is set to true but this property is not set, then the server automatically generates the encryption key.

For more information on how content encryption works, see Content encryption.

The end date, in Coordinated Universal Time (UTC) format, of the date range of a date-partitioned IBM Content Search Services index. Objects indexed in this index will have partitioning dates no later than this date. This property is set by the Content Engine server when the index is created. If there is no date partition constraint on this index, the value of this property is null.

A flag that indicates that replication will be permanently disabled on documents and annotations after the content has been moved. This property supports the use case of decommissioning an external repository that is no longer needed.

Set this property to true to disable replication on federated documents and annotations after the content is moved to a P8 storage area. After moving the content, the server sets the ReplicationGroup property to null on documents and annotations.

Specifies the trace flags applied to the classes in the Engine subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.

Specifies an error code for a publish request that is in an error state.

Specifies an error description for a publish request that is in an error state.

Trace flags corresponding to the Error subsystem. This value consists of a combination of TraceFlag constants.

The event action object that defines the actions to be taken when a event occurs that is subscribed to by a Subscription-based object (ClassSubscription, ClassWorkflowSubscription, InstanceSubscription, InstanceWorkflowSubscription). You set the property with an EventAction object, which must already exist in the object store. You then specify the property when you create the Subscription-based object.

Once this property is set, the Content Engine adds the Subscription-based object to the EventAction object's Subscriptions collection property.

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

The class definition of the event that's being subscribed to or audited.

An enumeration of CmEventExportStore objects that exist in this domain.

For Case Analyzer and Case History, the period in seconds that the event exporter will wait to acquire a lease for processing.

The Event object that triggered the queued event action.