Properties

This topic alphabetically lists all of the Content Engine API properties. Each property has a See Also section that lists the classes to which the property applies, and provides links to the list of properties for each class. Note that because the metadata for a property is class-specific, you must navigate to the list of properties by class for property metadata information.

[A]  [B]  [C]  [D]  [E]  [F]  [G]  [H]  [I]  [J]  [L]  [M]  [N]  [O]  [P]  [Q]  [R]  [S]  [T]  [U]  [V]  [W]  [X]  



A

APITraceFlags

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.

See Also



AbandonedContentCleanupInterval

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.

See Also



AbandonedDBContentCleanupInterval

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.

See Also



AccessMask

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

See Also



AccessType

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

See Also



ActiveDirectorySiteDNS

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 maps to 0 or 1 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.

See Also



ActiveMarkings

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.

See Also



AddOn

Specifies the add-on associated with this installation record.

See Also



AddOnInstallationRecords

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

See Also



AddOnName

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

See Also



AddOnType

Specifies whether the addon is optional or recommended for installation into an object store. During object store creation, Enterprise Manager 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 Enterprise Manager 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.

See Also



AddOns

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

See Also



AliasDirection

Specifies a ReplicationDirection constant that indicates the direction in which the mapping applies for this class or property alias.

See Also



AliasIds

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

See Also



AllRealms

A collection of all Realm objects for the EntireNetwork object.

See Also



AllowsContentToBeCached

Specifies whether the content data in this storage area can be cached (true) or not (false). The default is true.

See Also



AllowsDelete

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.

See Also



AllowsForeignObject

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

See Also



AllowsInstances

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.

See Also



AllowsNull

Indicates whether the column permits null values.

See Also



AllowsPropertyAdditions

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

See Also



AllowsSubclasses

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

See Also



AnnotatedContentElement

Specifies the index of 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 keep track of this property value nor does it enforce it for referential integrity.

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. The value of the ElementSequenceNumber property is server-generated and provides a unique and unchanging number for a given content element. Because the number of content elements of a document is variable, if you 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.

See Also



AnnotatedObject

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

See Also



Annotations

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

See Also



AppenderNames

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:

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

See Also



ApplicationGroupNumber

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

See Also



ApplyDefinition

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

See Also



ApplyStateID

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

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

See Also



ApplyTemplatePermissions

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

See Also



AsyncUpgradeType

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

See Also



AsynchronousProcessingTraceFlags

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.

See Also



AuditDefinitions

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

See Also



AuditFailure

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.

See Also



AuditLevel

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

See Also



AuditSuccess

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.

See Also



AuditedDeletePrefix

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

See Also



AuditedEvents

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

See Also



B

BaseClassIds

The IDs of the base classes associated with the VerityCollection instance. There will only be one ID value in this property for release 4.0 (or later) installations. For installations upgraded from a release prior to 4.0, there may be both Annotation and Document class ID values in this property, since these releases stored indexing information for both the Annotation and Document objects in the same Verity collection.

See Also



BatchDelay

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

See Also



BatchSelectionSize

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.

See Also



BlobReadAheadSize

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

See Also



BlobWriteCollisionsAvoidanceFlag

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:

See Also



BrokerPort

The service port number used to access this isolated region.

See Also



C

CBRLocale

The Verity locale used for the object store. Any valid locale name supported by Verity can be used. This value must be set before any 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.

See Also



CBRTraceFlags

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.

See Also



CFSDaemonTraceFlags

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.

See Also



CFSImportAgentTraceFlags

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

See Also



CFSNamingFactoryInitial

Deprecated. Due to changes in IBM Content Integrator, this property is no longer relevant.

See Also



CFSNamingProviderURL

Deprecated. Due to changes in IBM Content Integrator, this property is no longer relevant.

See Also



CFSPassword

For an external (non-FileNet-P8) repository, the password component of the credentials that CFS uses to logon in order to perform CFS functions. For more information on these credentials, including the name component of these credentials, see the CFSUserName property.

See Also



CFSUserName

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.

See Also



CMODApplicationGroups

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.

See Also



CMODLanguage

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

See Also



CMODPassword

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

See Also



CMODPort

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.

See Also



CMODServerName

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

See Also



CMODTraceLevel

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:

See Also



CMODUserName

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

See Also



CSMCache

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.

See Also



CacheStatus

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:

See Also



CanAcceptForwardedRequests

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.

See Also



CanBeDemoted

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.

See Also



CanForwardRequests

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.

See Also



Cardinality

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 PropertyTemplate object types, this property is settable on create:

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.

See Also



ChildComponent

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.

See Also



ChildDocuments

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.

See Also



ChildRelationships

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.

See Also



ChildVersionSeries

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.

See Also



ChoiceIntegerValue

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

See Also



ChoiceList

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

See Also



ChoiceLists

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

See Also



ChoiceStringValue

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

See Also



ChoiceType

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.

See Also



ChoiceValues

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.

See Also



ClassDefinition

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.

See Also



ClassDescription

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

See Also



ClassDescriptions

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.

See Also



ClassFamily

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.

See Also



ClassIdentity

Specifies one of the following:

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

See Also



ClassificationStatus

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:

See Also



ClosureDate

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

See Also



CodeModule

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.

See Also



CodeModuleCacheEntryTTL

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

See Also



CodeModuleCacheMaxFileSpace

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.

See Also



CodeModuleCacheMaxMemory

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

See Also



CodeModuleTraceFlags

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.

See Also



CollectionName

The name assigned to the Verity collection.

See Also



ColumnDefinitions

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

See Also



ColumnId

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

See Also



ColumnName

The name assigned to the column.

See Also



ColumnSize

The size of the column.

See Also



ComponentCascadeDelete

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:

See Also



ComponentPreventDelete

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:

See Also



ComponentRelationshipType

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:

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

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

See Also



ComponentSortOrder

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.

See Also



CompoundDocumentState

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:

See Also



ConcurrentReaders

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

See Also



ConfigurationParameters

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

See Also



ConnectionState

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

See Also



ConnectionTimeout

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.

See Also



ConstraintMask

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.

See Also



ContainedDocuments

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

See Also



Containees

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

See Also



Containers

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

See Also



ContainmentName

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:

The following characters are not allowed:

    \  /  :  ∗  ?  "  <  >  | 

Note: If AutoUniqueName.AUTO_UNIQUE is set when the object is filed, the server attempts to make this containment name unique.

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.

See Also



ContentAccessRecordingLevel

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

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

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

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

See Also



ContentCacheArea

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.

See Also



ContentCacheAreas

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

See Also



ContentCacheTraceFlags

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.

See Also



ContentElementCount

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.

See Also



ContentElementKBytes

The size of all content elements stored in this storage area (in kilobytes).

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.

See Also



ContentElements

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

See Also



ContentElementsCreated

Total content elements created in a Storage Area.

See Also



ContentElementsDeleted

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.

See Also



ContentElementsPresent

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.

See Also



ContentLocation

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

See Also



ContentQueueMaxWorkerThreads

The maximum number of worker threads that can exist simultaneously per Object Store. Content Queue Worker Threads are threads that are dedicated to the purpose of processing items from the content queue. Their primary function is to carry out the second stage of the content upload process. Worker threads process work from the ContentQueue in batches of one or more queue items.

See Also



ContentRetentionDate

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.

See Also



ContentSize

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.

See Also



ContentStorageTraceFlags

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.

See Also



ContentSummary

Represents a document's content summary.

See Also



ContentTempDirectoryRoot

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.

See Also



ContentType

Specifies the Multipurpose Internet Mail Extensions (MIME) format string of the content data carried by this content element, which indicates to the server what kind of data this content element represents. You can set the ContentType property of a specific content element when you create it and attach it to a document version. If you do not set the ContentType property, it is automatically set by the server.

MIME is a communications protocol that allows for the transmission of data in many forms, such as audio, binary, or video. A MIME format string consists of a content type, a content subtype, and an optional parameter in the following format: "MIME::content type/subtype[;parameter]". For example: "MIME::text/html".

MIME defines the following content types:

FileNet-specific MIME types include:

See Also



CopyToReservation

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

See Also



Creator

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.

See Also



CurrentState

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.

See Also



CurrentUser

The current user. The current user is the user under whose credentials RPCs are being performed.

See Also



CurrentVersion

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.

See Also



D

DITADatabaseTimeout

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

See Also



DITAHome

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.

See Also



DITAJVMArguments

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.

See Also



DITARenditionEngineConnection

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

See Also



DITARenditionEngineConnections

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

See Also



DITAWorkingDirectory

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.

See Also



DNSName

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

See Also



DataType

Specifies a TypeID constant, which indicates the data type of the value that an object property, choice list, or database table column can hold.

For PropertyDescription, PropertyDefinition, and PropertyTemplate object types, 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 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.

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.

See Also



DatabaseContentUploadBufferSize

Reserved for future use.

See Also



DatabaseIndexStorageLocation

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

See Also



DatabaseLOBStorageLocation

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

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

See Also



DatabaseName

Specifies the name of the database to which the object store is connected.

See Also



DatabaseServerName

Specifies the name of the host for the database to which an object store is connected.

See Also



DatabaseServerPort

Specifies the port number for a database server connection.

See Also



DatabaseTableStorageLocation

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

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

See Also



DatabaseTraceFlags

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.

See Also



DatabaseType

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

See Also



DateCheckedIn

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

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.

See Also



DateContentLastAccessed

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

See Also



DateCreated

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

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

See Also



DateLastModified

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

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

See Also



DefaultISDocumentClass

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.

See Also



DefaultInstanceOwner

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.

See Also



DefaultInstancePermissionDescriptions

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

See Also



DefaultInstancePermissions

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

See Also



DefaultQueryTimeLimit

The default value (in seconds) for the maximum amount of time that the server will allow a query to run before cancelling the query. This value can be overridden by a query.

See Also



DefaultReservationType

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:

See Also



DefaultRetentionDays

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

See Also



DefaultRetentionPassThrough

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

See Also



DefaultSite

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.

See Also



DeleteMethod

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:

See Also



DeletionAction

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

See Also



DependentDocuments

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

See Also



DequeueHost

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.

See Also



Description

Specifies a string that describes this object.

See Also



DescriptiveText

User-readable text that describes an object.

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

See Also



DescriptiveTexts

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.

See Also



DestinationDocuments

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

See Also



DestinationRepository

This property is not supported.

See Also



DeviceAddress

Specifies an IP address or fully qualified domain name.

See Also



DeviceRootDirectory

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.

See Also



DirectoryConfigurations

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, IBM Tivoli, Novell eDirectory, and SunOne) that will be queried by the Content Engine server when authorizing user and group names for login.

See Also



DirectoryServerHost

Specifies the name of the host that is running the directory server product.

See Also



DirectoryServerPassword

Specifies the user password used to authenticate to a given directory server. To set the value of this property, call set_DirectoryServerPassword, passing in an encrypted byte array. (See the Encryption.encrypt methods for information on encrypting the input.) Security measures prevent actual passwords from being returned, so a call to get_DirectoryServerPassword() returns a zero-length byte array instead, giving an indication that the property value has been set. If the password has not been set, the value returned by get_DirectoryServerPassword() is null.

See Also



DirectoryServerPort

Specifies the port number of the directory server. The FileNet® P8 Content Engine supports four directory server types: Microsoft® Active Directory®, IBM® Tivoli®, Novell eDirectory, and Sun Java™ System Directory Server (SunOne). The value of this property defaults to port 389 for all supported directory server types.

See Also



DirectoryServerProviderClass

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:

See Also



DirectoryServerType

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

See Also



DirectoryServerUserName

Specifies the username for authenticating to the directory server. The following are examples of strings for Active Directory and SunOne directory servers:

See Also



DirectoryStructure

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:

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.

See Also



DispatcherEnabled

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.

See Also



DispatcherWaitInterval

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:

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.

See Also



DisplayName

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

See Also



DisplayNames

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.

See Also



DistinguishedName

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

See Also



DocumentClassificationActions

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.

See Also



DocumentLifecycleAction

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.

See Also



DocumentLifecycleActions

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

See Also



DocumentLifecyclePolicies

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

See Also



DocumentLifecyclePolicy

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.

See Also



DocumentStates

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.

See Also



DocumentsPerBatch

The maximum number of documents placed into a batch.

See Also



Domain

The FileNet P8 domain to which a given object belongs.

See Also



DomainId

Specifies the unique identifier of a domain.

See Also



DuplicateSuppressionEnabled

This property is not supported.

See Also



DynamicGroupMemberAttribute

This property is not supported.

See Also



DynamicGroupObjectClass

This property is not supported.

See Also



DynamicGroupQueryAttribute

This property is not supported.

See Also



E

EJBForwardingEndpoint

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

The maximum length of the URI string is 2083 characters.

See Also



EJBTraceFlags

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.

See Also



ElementSequenceNumber

A unique sequence number for a content element in a document or annotation object. 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.

See Also



Email

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

See Also



EmbeddedDataThreshold

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

See Also



EnableManualLaunch

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

See Also



EncryptionAlgorithm

A string identifying the algorithm used to encrypt data using the Domain object's public key. The value of this property specifies how to perform the encryption operation using the retrieved key, and takes the form of a Java™ Cryptography Extension (JCE) transform string, for example, RSA/NONE/PKCS1PADDING.

See Also



EngineTraceFlags

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.

See Also



ErrorCode

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

See Also



ErrorDescription

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

See Also



ErrorTraceFlags

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

See Also



EventAction

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.

See Also



EventActions

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

See Also



EventClass

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

See Also



EventObject

The Event object that triggered the queued event action.

See Also



EventStatus

For a system event, this property indicates whether the operation that caused the creation of this event was successful. Zero (0) indicates a successful operation; otherwise, an error code is returned.

For a custom event, this property can be set by a client application to convey state to the event action handler. Therefore, it is up to the client application and event action handler to define and interpret the value of this property. In the event action handler, this property can be retrieved from the event object passed to the handler.

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.

See Also



EventsTraceFlags

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

See Also



ExpiredBatchSelectionSize

Batch selection size used when updating expired requests. An item in the Content Queue is said to expire when its LeaseDuration has been exceeded. Expired items must be updated so they can be retried. Expired queue items are updated in batches, the size of which is dependent on the value of this property.

See Also



ExternalAliases

Specifies an ExternalPropertyAliasList collection of the external aliases defined for this property definition or replicable class definition.

See Also



ExternalClassDescriptions

Specifies an ExternalClassDescriptionSet object containing the set collection of ExternalClassDescription objects associated with this external repository.

See Also



ExternalObjectIdentity

Specifies the unique identity of this external replica object, relative to an external repository in which a replica of the object exists.

See Also



ExternalPropertyDescriptions

Specifies an ExternalPropertyDescriptionSet object containing the set collection of ExternalPropertyDescription objects associated with this external class description.

See Also



ExternalReplicaIdentities

Specifies an ExternalIdentityList collection of the ExternalIdentity objects representing the identities of replicas of this object in external repositories.

See Also



ExternalRepositories

Specifies an ExternalRepositorySet object containing the set collection of ExternalRepository objects associated with this domain.

See Also



ExternalRepository

Specifies one of the following:

See Also



F

FPOpenStrategy

Specifies the approach used by FPPool.Open to open connections. Possible values are:

See Also



FPPoolBufferSize

Specifies the size in bytes of the internal C-Clip buffer. The default value is 16*1024.

See Also



FPPoolClusterNonAvailTime

Specifies the time in seconds that a cluster is marked as not available before retrying with a probe. Other clusters in the pool will be used while the cluster is unavailable. The default value is 600 (10 minutes).

See Also



FPPoolDefaultCollisionAvoidance

Indicates whether collision avoidance is enabled at the pool level (true) or not (false). By default, collision avoidance is not enabled. If enabled, an additional blob discriminator for read and write operations of C-Clips and blobs will be used. (BlobWriteCollisionAvoidanceFlag is used in tag write and only applies to blobs.)

See Also



FPPoolEnableMulticlusterFailover

Specifies whether multi-cluster failover is enabled (true) or not (false). By default, multi-cluster failover is enabled.

See Also



FPPoolMaxConnections

Specifies the maximum number of sockets that will be allocated. (Sockets are used to communicate with the Centera clusters managed in each pool object.) The default value is 100.

See Also



FPPoolMulticlusterDeleteStrategy

Specifies the failover strategy for delete operations (FPClip.Delete and FPClip.AuditedDelete) and the deprecated purge operations (FPClip.Purge and FPTag.BlobPurge). Possible values are:

See Also



FPPoolMulticlusterExistsStrategy

Specifies the failover strategy for exists operations (FPClip.Exists and FPTag.BlobExists). Possible values are:

See Also



FPPoolMulticlusterQueryStrategy

Specifies the failover strategy for query operations (FPPoolQuery.Open). Possible values are:

See Also



FPPoolMulticlusterReadStrategy

Specifies the failover strategy for read operations (FPClip.Open, FPTag.BlobRead, and FPTag.BlobReadPartial). Possible values are:

See Also



FPPoolMulticlusterWriteStrategy

Specifies the failover strategy for write operations (FPClip.Write and FPTag.BlobWrite). Possible values are:

See Also



FPPoolPrefetchSize

Specifies the size of the prefetch buffer. (The buffer is used to assist in determining the size of the blob.) The default size is 32 KB.

See Also



FPPoolRetryCount

Specifies the number of times an operation will be retried before failure is reported. The default value is 6. If the first execution of the function fails, the system will retry the function 6 more times (for a total of 7 tries).

See Also



FPPoolRetrySleep

Specifies the time to wait in milliseconds before a failed API function should be retried. If not specified, an exponential back-off scheme is used where the sleep time increases after each retry, starting at 1 second and then doubling after each subsequent try.

See Also



FPPoolTimeout

Specifies the TCP/IP Connection timeout in milliseconds. The default value is 120000 (2 minutes).

See Also



FcpPoolIdleTimeoutSeconds

The number of seconds an idle connection can remain in the fixed content device provider pool before being eligible to be closed and removed from the pool. An idle connection will be closed when the next operation to the same fixed content device is performed after this idle period.

See Also



FcpPoolMaxInUse

The maximum number of concurrent connections allowed for the fixed content device. A value of -1 indicates that there is no limit.

See Also



FcpPoolMaxWaitSeconds

The maximum number of seconds to wait for a connection once the limit specified by the FcpPoolMaxInUse property has been reached. If a connection from the fixed content device provider pool does become available before this wait time expires, the request is allowed to proceed.

See Also



FcpPoolPreferredSize

The minimum size to which the fixed content device provider pool will be allowed to shrink after the idle timeout has expired.

See Also



FederationJNDIDataSource

The JNDI name of the data source for the federator database associated with the external (non-FileNet-P8) repository.

For a related JNDI name, see the FederationJNDIXADataSource property. For information on specifying the external repository, see the SourceRepositoryName property.

See Also



FederationJNDIXADataSource

The JNDI name of the XA data source for the federator database associated with the external (non-FileNet-P8) repository.

For a related JNDI name, see the FederationJNDIDataSource property. For information on specifying the external repository, see the SourceRepositoryName property.

See Also



FederationUpdateHasPriority

A boolean value that specifies whether CFS, when importing document metadata from an external (non-FileNet-P8) repository into a FileNet P8 repository, treats the changes made to documents residing in the external repository as having greater priority than any changes made to corresponding FileNet P8 documents. When the value of this property is true, the external document changes have priority, and CFS unconditionally updates FileNet P8 documents with the imported metadata. When false, CFS updates a FileNet P8 document only if the document has not been changed more recently than the corresponding external document.

Suppose, for example, that a FileNet P8 document X exists with a corresponding external document Y, a user within the FileNet P8 repository has changed the metadata for X yesterday, a user within the external repository has changed the metadata for Y the day before yesterday, and CFS, as scheduled, imports metadata today from the external repository into the FileNet P8 repository. CFS discovers that X has been changed more recently than Y, and therefore does not update X with the metadata from Y (presuming that the FederationUpdateHasPriority property has a value of false).

CFS performs the change date comparison based on the FileNet P8 DateLastModified property and the corresponding property on the external document. If the external document has no such corresponding property, CFS unconditionally updates FileNet P8 documents with imported metadata regardless of the value of this property.

See Also



FilterExpression

The text of a filter expression that, when evaluated, determines the action to be taken on the object.

For a StoragePolicy object, FilterExpression is used as the selection criteria for determining into which storage area the content for a document or annotation should be stored. The expression is evaluated against all storage areas to determine which ones are deemed "equivalent" in terms of this storage policy.

For a Subscription-based object, FilterExpression is used to determine whether the event action should be launched. The filter is applied to either the source object, or optionally to the object specified by the Subscription-based object's FilteredPropertyId property. Note that for version series subscriptions, the filter is applied to the document version in the transaction and not to the version series.

The filter evaluation occurs as part of processing an event's subscriptions. The Content Engine server evaluates the filter expression, as follows:

Note  If, in a document subscription that specifiesPublishRequestEvent as a subscribed event, you want to apply a filter expression to the document being published, you must set the subscription's FilteredPropertyId property to the PublishRequest object's InputDocument property. (When you publish a document, a PublishRequest object is created, which, at runtime, is the object that triggers PublishRequestEvent, not the document being published.)

For both a StoragePolicy object and a Subscription-based object, the syntax of this property must be a fragment of a SQL where-clause expression (for example, VersionStatus = 1) and use supported operators. Note that some operators that are valid in a Content Engine query are not supported. The following operators are not supported.

See SQL Syntax Reference.

Note that a filter expression can include conditions expressed against non-queryable and non-persistent properties. For example, the following is a valid expression: Owner='jsmith'

A filter expression using the IsClass operator must be constructed in the following fashion (not case-sensitive): IsClass(Source,<Class_id>). Class_id can be either a symbolic name or a GUID.

In a filter expression using the IN operator, the following conditions apply:

See Also



FilteredPropertyId

The symbolic name of a singleton, object-valued property defined on the source object for use in evaluation by the filter expression. (The filter expression is defined by the FilterExpression property). For example, an event on a ReferentialContainmentRelationship can specify Head in the FilterPropertyId property to have the containable object -- rather than the ReferentialContainmentRelationship -- used for filtering.

The use of a filter expression is optional. If FilterPropertyId is null, the source object itself is evaluated by the filter expression.

Note  If, in a document subscription that specifiesPublishRequestEvent as a subscribed event, you want to apply a filter expression to the document being published, you must set this property to the PublishRequest object's InputDocument property. (When you publish a document, a PublishRequest object is created, which, at runtime, is the object that triggers PublishRequestEvent, not the document being published.)

See Also



FixedContentDevice

Specifies a fixed content device associated with this FixedStorageArea object.

See Also



FixedContentDevices

Specifies the collection of fixed content devices defined for a domain.

See Also



FixedContentProviderTraceFlags

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

See Also



FolderCacheMaxAgeDelta

Deprecated.

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

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

See Also



FolderCacheMaxEntries

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

See Also



FolderCacheReapFrequency

Deprecated.

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

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

See Also



FolderName

The name of the folder. This cannot be an empty string. The following characters are not allowed:
    *  \  /  :  *  ?  "  %lt;  >  | 

See Also



FoldersFiledIn

A FolderSet collection object containing the Folder objects in which this document is filed.

See Also



ForceCaseInsensitiveSearch

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

See Also



FromVersions

Specifies a list of IDs that identify the add-on versions upgraded by an UpgradeAddOn object. The list must contain one or more IDs (and will usually contain only one).

See Also



FullTextRowDefault

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

See Also



FullTextRowMax

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

This limit prevents excessive resource use during a search operation.

See Also



G

GCDCacheTTL

Specifies the Time-To-Live value (TTL) value (in seconds) for the Global Configuration Database (GCD) cache. The range of values is 1 to 3600 seconds with a default of 30 seconds. The cache is flushed following the completion of a transaction (update) and automatically reloaded on the updating server. Following the expiration of this TTL value a database query is issued, at which time the software determines whether the cached data is stale or not.

Multiple server configurations might require a more frequent cache update polling interval (that is, a smaller TTL value) if GCD updates are a normal occurrence. However, since objects residing in the GCD are designed to be static in nature, updates to GCDCacheTTL are unlikely.

See Also



GCDTraceFlags

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

See Also



GranteeName

The distinguished name (DN) or short name of the user or group to whom an access permission is granted.

See Also



GranteeType

Specifies whether a group or a user is being granted a permission.

See Also



GroupBaseDN

Specifies the base Distinguished Name (DN) for searching for groups in the directory server.

See Also



GroupDisplayNameAttribute

Specifies the directory server attribute to be used as the display name for a group. The default property value is dependent on the directory service type and is specified by the authentication provider's configuration.

See Also



GroupMembershipSearchFilter

Specifies the search filter for group membership queries.

The default value of this property is null for Active Directory service provider. The default value for other supported directory service providers is unique to the provider, as follows:

See Also



GroupNameAttribute

Defines the directory server attribute to be used as the short name for a group. The default value of this property is samAccountName for the Active Directory service provider and cn for all other supported directory service providers.

See Also



GroupSearchFilter

Specifies the search filter for querying a group or groups. The filter must be in the following format: "(&(objectClass=user_defined_class)(an_attribute={0}))", where user_defined_class is the object class you want (for example, user) and an_attribute is the LDAP server-specific attribute (for example, samAccountName, cn, or uid).

The default value of this property is unique to the directory service provider, as follows:

See Also



GroupUniqueIDAttribute

This property is not supported.

See Also



GroupUniqueIDAttributeIsBinary

This property is not supported.

See Also



Groups

A collection of Group objects belonging to a given realm or group.

See Also



H

HasHierarchy

Specifies whether a given choice list has a hierarchical structure (true) or not (false).

See Also



HasIncludeSubclasses

Specifies whether a given class supports queries that include its subclasses (true) or not (false).

See Also



HasProperSubclassProperties

Specifies whether a given class supports queries that include descendant properties (true) or not (false). A descendant property is a property that is added to one or more subclasses of a class.

See Also



Head

An IndependentlyPersistableObject instance that participates in a binary relationship as the logical head (containee) in a relationship between two objects.

For a DynamicReferentialContainmentRelationship object, the head is always a Versionable object representing the current document version.

For a ReferentialContainmentRelationship object, the head can be any of the Containable subclasses (such as a CustomObject, Document, or Folder object). In this case, when the head is a Document object, it represents a specific document version.

For a Link object, this property can specify any object that is a subclass of the IndependentObject base class.

See Also



HeldUntilDate

This property is not supported.

See Also



I

IICEConfigurationServerURL

The URL that needs to be provided to the IBM Content Integrator API in order for it to locate the Configuration Server.

See Also



ISDomainName

Specifies the domain name component of the NCH name. The NCH name specifies the address of the target Image Services server. It's derived from the ISDomainName and ISOrganization properties.

See Also



ISOrganization

Specifies the organization component of the NCH name. The NCH name specifies the address of the target Image Services server. It's derived from the ISDomainName and ISOrganization properties. In most cases, this value will be "FileNet".

See Also



ISPassword

Specifies the encrypted password for the security principal identified by the ISUserName property.

See Also



ISUserName

Specifies the name of the security principal that will be used to access the Image Services server. The name must already exist as an "integration user" in the IS security database used by CFS-IS.

See Also



Id

A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For User and Group classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, calls to User.get_Id() and Group.get_Id() always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

See Also



Ids

Specifies an IdList object containing the collection of all of the IDs used to identify this class description or property description. The collection includes the value of this class description or property description's Id property and the values of any assigned alias IDs.

See Also



ImageServicesClassDescriptions

Specifies an ImageServicesClassDescriptionList object, which contains a collection of the Image Services document class descriptions associated with this FileNet Image Services fixed content device.

See Also



ImageServicesClassName

Specifies the name of the class described by this Image Services (IS) document class description, which must corresponds to an existing IS document class defined on the IS server. This property is used by the IS Import Agent to map an IS document class to a Content Engine document class when importing federated documents.

See Also



ImageServicesDataType

Specifies the data-type identifier of the property described by this Image Services property description, which is the Content Engine data type corresponding to the Image Services server data type for a given property.

See Also



ImageServicesPropertyDescriptions

Specifies an ImageServicesPropertyDescriptionList object containing an ordered collection of all of the Image Services (IS) property descriptions belonging to this IS document class description. This property contains the IS properties associated with an existing IS document class on the IS server and is used by the IS Import Agent to map IS document properties to Content Engine properties when importing federated documents.

See Also



ImageServicesPropertyName

Specifies the name of the property described by this Image Services (IS) property description, which must corresponds to an existing IS property of the same name. This property is used by the IS Import Agent to map the properties of an IS document to Content Engine properties when importing federated documents.

See Also



ImmediateSubclassDefinitions

Specifies a ClassDefinitionSet object, which contains a ClassDefinition object for each class that is an immediate subclass of the class defined by this ClassDefinition object.

See Also



ImmediateSubclassDescriptions

Specifies a ClassDescriptionSet object, which contains a ClassDescription object for each class that is an immediate subclass of the class described by this ClassDescription object.

See Also



ImplementationClass

Specifies the name of the fixed content provider class that implements the behavior for a fixed content device. The classes include:

See Also



ImportAgentRetryCount

Specifies the number of retries the ImportAgent thread will attempt.

See Also



InboundBatchSize

This property is not supported.

See Also



InboundBusyWaitInterval

This property is not supported.

See Also



InboundDispatcherEnabled

This property is not supported.

See Also



InboundFileNameCacheMaxEntries

Maximum number of inbound file names to keep in an LRU cache (default 2K).

See Also



InboundIdleWaitInterval

This property is not supported.

See Also



IncludeSubclassesRequested

Indicates whether the operation should apply to the subclasses of the class. For a ClassSubscription object, this property indicates whether the subscription should also apply to the subclasses of the target class. For an AuditDefinition object, this property indicates whether auditing should also apply to the subclasses of the class configured for auditing.

See Also



IndexArea

The IndexArea object containing the Verity collection referenced by the IndexationId property.

See Also



IndexAreas

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

See Also



IndexItems

The list of classes or collections to index. All objects in this list are a subclass of IndexJobItem.

See Also



IndexationId

The object ID (GUID) of the Verity collection used. This will be null for objects that were full text indexed prior to the 4.0 release.

This property must be set if the property is to be CBR enabled (the PropertyDefinitionString.IsCBREnabled property).

See Also



InheritParentPermissions

Defines whether a given folder can inherit permissions from its parent folder.

See Also



InheritableDepth

The maximum depth to which a permission (ACL) can be inherited. As the ACL gets inherited in a tree of objects, the value is decremented. Example values are as follows:

See Also



InitiatingUser

The authentication provider's LDAP Distinguished Name (DN) of the user that initiated the event.

This property is available for asynchronous events only. For synchronous events, get the current user from the server context.

See Also



InlineContentRetrievalLimit

The limit of the size for inline content retrieval.

See Also



InputDocument

Specifies the input document to use for this publish request.

See Also



InputFormats

Specifies a list of input document MIME types supported for this style template.

See Also



InstallationDate

Specifies the date and time when the installation was completed.

See Also



InstallationReport

Contains the installation report formatted as an XML string. If the installation was successful, the value will be null.

See Also



InstallationStatus

Specifies the current status of the add-on installation request (either Installed or InstallationFailure).

See Also



Installer

Specifies the name of the user who issued the add-on installation request.

See Also



IsCBREnabled

Specifies whether this class or property is enabled for full text indexing (content-based retrieval).

For classes, the following conditions apply:

For properties, this property can be enabled only on Document, Annotation, CustomObject, and Folder objects.

See Also



IsCurrentVersion

Specifies whether this document version is the current (latest) version object of a document's version series (true) or not (false). The current version can be a major version or a minor version.

See Also



IsEnabled

Indicates whether a given object is enabled or disabled. For example, you can globally disable or enable active events by setting an EventAction object's IsEnabled property to false (off) or true (on). Likewise, you can enable or disable a subscription or a security template. Enabling a security template indicates that it can be applied to an object. A disabled security template remains part of its security policy container, but cannot be applied to an object. Disabling a security template is useful when you are testing or developing the security templates that make up a security policy. Disabling a subscription prevents the function associated with the event from being loaded and executed. You might want to disable a subscription that is undergoing modifications due to a change in business processes or when you do not want functions to execute against federated documents. Note that when you disable an EventAction, all of its associated subscriptions are also disabled. However, when you disable one particular Subscription, you only disable events that are in its subscribed event list.

See Also



IsFrozenVersion

Specifies whether this document version is a frozen version (true) or not (false). If a document version is frozen, you cannot modify its custom properties. However, you may be able to modify the custom properties of other versions of that document, provided they have not been frozen. Note that the modifiability of a document's system properties is not affected by a document version's frozen status.

See Also



IsHidden

Indicates whether this class or property should be hidden from non-administrative users (true) or not (false).

See Also



IsHierarchical

Specifies whether the marking set is hierarchical or not.

A non-hierarchical marking set contains one or more markings, each independent of all others. A hierarchical marking set has an order of precedence to its markings determined by their order in the set. Its markings are arranged in a simple, single branch hierarchy. This order of precedence is followed when evaluating access rights. Each marking has a superior marking (which must be in the same set), except for the top marking (its superior is null). A marking in a hierarchical marking set explicitly grants access rights to a set of security principals. It also implicitly grants the same rights for all markings that are inferior to it in the hierarchy.

See Also



IsImportAgentEnabled

A boolean value that controls the run enabled status of the import agent sub-component of the CFS importer. When false, the agent does not run. When true, the agent runs, but the importer as a whole might still not process import requests when the dispatcher sub-component has not also been enabled. For more information, see the DispatcherEnabled property on the CFSImportAgentConfiguration interface.

For a discussion of the importer sub-components, see the CFSImportAgentConfiguration interface.

See Also



IsInExceptionState

Specifies whether the lifecycle state of this document is in an exception state (true) or not (false). As long as a document is in an exception state, its lifecycle state can neither be promoted nor demoted. To clear a document from an exception state, you must call its changeState method and set the LifecycleChangeFlags parameter to CLEAR_EXCEPTION.

See Also



IsNameProperty

Specifies whether the value of a property provides the name of the object instances of the class to which it belongs (true) or not (false). An object that has a designated name property (the IsNameProperty property of one of its properties is set or the NamePropertyIndex property of the object's class description is set) will have the designated name property's value assigned to its Name property. An object can have only one designated name property.

See Also



IsOrderable

Indicates whether this property can appear in the ORDER BY clause of a query.

See Also



IsPersistent

Specifies whether you can save the state of the object instantiation of this class (true) or not (false). If this property is false, only the server can save the state of the object.

See Also



IsReadOnly

Specifies whether you can modify the value of the property described by this property description (true) or not (false). If IsReadOnly is true, the property's value can only be changed by the server.

See Also



IsReserved

For a Document object, specifies whether a user has reserved the right to check in the next version following this version (true) or not (false). For a VersionSeries object, specifies whether the current version in this version series is checked out (true) or not (false).

See Also



IsSSLEnabled

Defines whether or not Secure Sockets Layer (SSL) protocol is enabled for a given DirectoryConfiguration object. The default value for all directory server types supported by the IBM FileNet P8 Content Engine is false, indicating that SSL is disabled.

See Also



IsSearchable

Specifies whether the class or property can be used as part of the search criteria for a query.

See Also



IsSecurable

Identifies whether objects of the described class have independently settable security.

Unlike a dependently securable object, which inherits its security from a parent object, an independently securable object has its own Access Control List (ACL) that specifies its security and ensures that access rights are checked each time a user tries to access the object. As an example, a Document object is the security parent of its dependent ContentElement objects. The value of this property is true if the given object's security is independently settable (as in the case of Document) and is false if the object's security is inherited from a security parent (as in the case of a ContentElement).

See Also



IsSelectable

Specifies whether the class or property can be selected in a query result set.

See Also



IsSingleIndexed

Manages usage of a user-defined index on this column.

See Also



IsSynchronous

The method by which the event procedure code is executed for a Subscription-based object (ClassSubscription, ClassWorkflowSubscription, InstanceSubscription, InstanceWorkflowSubscription). To execute the event procedure synchronously, set the property to true. To execute the event procedure asynchronously (in the background), set the property to false. The default is false. Specify the property when you create the Subscription-based object.

When an asynchronous event procedure is triggered, the action occurs on a separate execution thread, allowing the subscription processor to continue without waiting for the results of the action. The Content Engine inserts the event into the QueueItem table, after any other waiting asynchronous operations, and executes it when resources permit. While execution usually occurs instantaneously, there might be a delay if many other asynchronous events or operations (such as security propagation or XML classification) are waiting in the queue. If your application depends on a particular asynchronous event procedure being completed, your application should first test the status of that event to verify its completion.

If the asynchronous event action fails, the exception comes back to the server. The event action transaction rolls back, but the transaction of the originating activity executes.

Note that for domains in which there are multiple Content Engine server instances, any server in the domain can handle a queued asynchronous event, not just the server that generated the event.

When a synchronous event procedure is triggered, the call to execute the event action blocks further processing by the subscription processor until the action completes. The action runs in the same transaction as the originating activity on the target object. If the action fails, the exception comes back to the client. The single transaction rolls back; therefore, the originating activity fails along with the event action.

Note that, for a workflow subscription, this property is read-only with a value of false because a workflow subscription's event is always fired asynchronously on Content Engine.

See Also



IsSystemGenerated

Indicates whether the property described by a given property description has its value set automatically by the Content Engine server (true) or not (false). In general if IsSystemGenerated is true, the described property either provides system information (for example, DateCreated) or has its value determined by the server according to the results of a method call or some other operation (for example, if you call a folder's CreateSubFolder method, the system will automatically add the newly created folder to the collection of objects returned by the SubFolders property).

See Also



IsSystemOwned

Indicates whether a given class or property was originally created by the Content Engine (true), as opposed to user-created (false).

See Also



IsValueRequired

Indicates whether the property represented by a given property description, property definition, or property template is required to have a value (true) or not (false). If you attempt to save an object containing a property that requires a value and that property does not have a value assigned to it, an exception will result.

See Also



IsVersioningEnabled

Specifies whether you can create a new version of this object (true) or not (false).

See Also



IsolatedRegion

The isolated region to which this connection point provides access.

See Also



IsolatedRegionNumber

The unique ID number identifying this isolated region.

See Also



IsolatedRegions

An IsolatedRegionSet object containing the list of isolated regions (IsolatedRegion instances) available in this P8 domain.

See Also



J

JNDIDataSource

Specifies the Java™ Naming and Directory Interface (JNDI) name of the DataSource defined in the Java™ 2 Platform Enterprise Edition (J2EE) application server, which can be used to access the object store database via a non-XA database connection.

See Also



JNDIXADataSource

Specifies the Java™ Naming and Directory Interface (JNDI) name of the DataSource defined in the Java™ 2 Platform Enterprise Edition (J2EE) application server, which can be used to access the object store database via an XA database connection.

See Also



JobAbortRequested

Indicates whether this indexing job has been requested to abort.

See Also



JobStatus

The status of the indexing job. This can be one of the following: Pending, InProgress, AbortInProgress, TerminateNormally, or TerminatedAbnormally.

See Also



L

LabelBindValue

The value matched against the value of the ComponentBindingLabel property on a child component document version that determines whether that version gets bound in a component relationship of type DYNAMIC_LABEL_CR. For all other component relationship types the value of this property is null. For more information, see ComponentRelationshipType Property.

See Also



LastFailureReason

This property is not supported.

See Also



LastModifier

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

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

See Also



LeaseDuration

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

The maximum interval, in seconds, allowed a worker to process a batch before the assignment of the batch to another worker. This interval ensures that any abnormal termination of the worker previously assigned to the batch does not prevent batch completion.

See Also



LifecycleOperation

The lifecycle operation performed on the source object. This property is set to a LifecycleChangeFlags constant value, which specifies the state of the lifecycle operation.

See Also



LocalDomain

The FileNet P8 domain.

See Also



LocaleName

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

See Also



LocaleNames

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

See Also



LocalizedText

The user-readable text presented in the language of a specific locale. This localized text is used for displaying names or descriptive text. For database-specific information regarding the maximum length allowed for this property, see Database Engine Differences.

See Also



LockDownExceptionList

Deprecated. Due to changes in IBM Content Integrator, this property is no longer relevant.

See Also



LockDownPrincipal

Deprecated. Due to changes in IBM Content Integrator, this property is no longer relevant.

See Also



LockDownPrincipalType

Deprecated. Due to changes in IBM Content Integrator, this property is no longer relevant.

See Also



LockOwner

Identifies the owner that exclusively holds the advisory lock on the object. This property is populated as a result of a successful call to the lock method. The value of this property is simply a custom string that has no real effect in determining the user of the lock. The owner specified by this property is not validated against any user or group known to the Content Engine. This property is set to null if the unlock method is called; if the lock expires naturally, then the value remains unchanged.

See Also



LockTimeout

The number of seconds beyond the last modified date that the server will retain a lock. This property's value is used to calculate a lock's expiration time. The property's value is populated as a result of a successful call to the lock method; however, the value can be updated by a call to updateLock. The property value is the number of seconds beyond the value in the object's DateLastModified property that the user of the lock can hold the lock on the object. The result of the calculation is measured against the current system time. The lock is considered expired when the value of the object's DateLastModified property plus the value of the LockTimeout property is less than the current system time. (All millisecond components are dropped from the calculation.) This property is set to null if the unlock method is called; if the lock expires naturally, then the value remains unchanged.

See Also



LockToken

Identifies the token used to signal that a lock exists on an object. The token is a unique identifier (GUID) that represents the lock. When the lock on the object is released (via unlock), the value of LockToken is set to null. (If the lock expires naturally, then the value remains unchanged.)

See Also



M

MajorVersionNumber

Specifies the major version number of this document version. A document's major version number is set to 1 the first time that you check it in as a major version and then incremented by 1 for each additional time that you check it in as a major version.

See Also



MappableDirection

Specifies the direction in which the external property described by this external property description can be mapped for replication with respect to a Content Engine property.

See Also



Marking

Specifies a marking that is applied to an object for access control purposes. A call to get_Marking() on a given ActiveMarking object returns this object-valued property.

See Also



MarkingSet

Specifies the set of markings for a given string-valued property. A MarkingSet is a container that holds all of the possible values for a particular marking-enabled property. Each Marking object in the marking set represents a different value for the property.

You can retrieve a string-valued property's marking set by calling get_MarkingSet() method on the PropertyDefinitionString, PropertyTemplateString, or PropertyDescriptionString interfaces.

See Also



MarkingSetCacheEntryTTL

Specifies the Time-To-Live (TTL) in milliseconds for entries in the marking set cache. Once the TTL has elapsed, cached information that has become stale is discarded and fresh data is obtained.

See Also



MarkingSetCacheMaxEntries

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

See Also



MarkingSets

Specifies a collection of MarkingSet objects.

See Also



MarkingUseGranted

Contains a bit mask that identifies which access rights have been granted to the current user. A user can be granted "Use", "Remove", and "Add" rights. The "Remove" and "Add" rights determine if the current user can remove or add a marking value on an independent object.

The primary use of this MarkingUseGranted property is to detect whether the current user has the "Use" right. The "Use" right determines whether the presence of the marking on an object constrains access to that object. If the user has "Use" right to the marking, access to associated independent objects will not be constrained by the value of the ConstraintMask property on the Marking object. The absence of the "Use" right means that the values in the ConstraintMask property will be subtracted from the associated object's effective access calculation (which is the value returned by the IndependentlyPersistableObject.getAccessAllowed() method). In this case, the constraint mask of the marking identifies which rights cannot be granted, and will be ignored, which effectively removes those rights granted on the associated independent object's ACL.

See Also



MarkingValue

Specifies the value to use when applying a Marking to an object that has a property associated with a MarkingSet. This value of a marking must be unique within a marking set.

See Also



Markings

Holds a MarkingList object, which contains a collection of Marking objects.

See Also



MaxBatchSize

The maximum number of objects that can be submitted in a single batch for indexing. Normally, the default value should be used.

See Also



MaxCollections

The maximum number of collections that can be created in this index area. If this number is exceeded, the server sets the IndexArea.ResourceStatus property to "closed", and for this same site and object store, changes to "open" the ResourceStatus value of the first index area found having a ResourceStatus value of "standby".

See Also



MaxInMemoryElementState

The maximum number of elements for the in-memory state cache. Each in-memory element corresponds to a content element in the cache.

One in-memory state cache exists per server. The state cache contains state information on content elements in the primary content cache area for a server, and can potentially improve the performance of a server by reducing the number of disk accesses the server must make to retrieve state information. For example, by storing the create date/time for a cache content element, the server can determine whether other previously retrieved information remains valid (thereby possibly avoiding the need to re-retrieve information for the content element).

See Also



MaxInMemoryItems

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

This value, in combination with the MaxWorkerThreads parameter, establishes a threshold that, when exceeded, prevents additional batches of federation requests from being inserted in the in-memory pre-fetch queue. The number of items in the queue is reduced as batches of work are dispatched to worker threads. The number of batches in the queue will eventually fall below the threshold and the addition of new batches from the database queue will be resumed.

See Also



MaxInMemoryQueueItems

Maximum [un-dispatched] requests allowed in the in-memory queue (to avoid throwing away batches that expire while held in-memory, this number is kept very low by default, but can be increased under certain circumstances, like content migration to a slow device). Note that this limit is not evaluated until there are at least three in-memory pending batches.

See Also



MaxInboundWorkers

This property is not supported.

See Also



MaxObjectsPerCollection

The maximum number of objects a Verity Collection can contain. Do not set this lower than the default unless testing collection overflow.

See Also



MaxOutboundWorkers

This property is not supported.

See Also



MaxQueryTimeLimit

The maximum amount of time (in seconds) that the server will allow a query to run before canceling the query. This cannot be overridden by an individual query.

Setting this value helps to prevent excessive server resource usage by a single user.

See Also



MaxReaderSemaphoreWaitTime

Specifies the maximum waiting time in milliseconds to get a read semaphore for a read operation before the system fails the operation.

See Also



MaxResolutionBatchSize

Maximum number of items to resolve within a batch.

See Also



MaxWorkerThreads

The maximum number of import workers that the import agent is allowed to create. Setting the value of this property appropriately prevents the under- or over-utilization of the Content Engine server on behalf of the CFS importer.

For information on the CFS import agent, see the CFSImportAgentConfiguration interface.

See Also



MaximumContentElements

The maximum number of content elements designated for this storage area.

For a content cache area, new content can be added to a cache only if the number-of-content-elements statistic (the ContentElementCount property) is less than this maximum. (This maximum might be slightly exceeded, as statistics are managed on a delayed basis, and multiple servers can be adding content.) The value for this property must be greater than or equal to 1.

See Also



MaximumLengthBinary

Specifies the maximum length, in bytes, of a value for a property that returns a BINARY data type.

See Also



MaximumLengthString

Specifies the maximum length, in characters (excluding the null terminator), of a value for a property that returns a STRING data type.

See Also



MaximumRetentionDays

Specifies the maximum retention period in days.

See Also



MaximumSizeKBytes

The maximum size of all content elements designated for this storage area (in kilobytes).

For a content cache area, new content can be added to a cache only if the size-of-content-elements statistic (the ContentElementKBytes property) is less than this maximum. (This maximum might be slightly exceeded, as statistics are managed on a delayed basis, and multiple servers can be adding content.) The value for this property must be greater than or equal to 1.

See Also



MaximumTimeToLive

The maximum number of minutes a content element can remain in an unaccessed state in the cache and not be considered an expired file. An expired file is subject to deletion during a prune action. Note that prune actions delete files for other reasons besides expiration. For an overview of pruning and a discussion of the categories of files deleted during a prune action, see the ContentCacheArea class.

A periodic prune occurs at maximum-time-to-live half-intervals. For example, if the specified maximum-time-to-live is two weeks, a periodic prune occurs once a week. The purpose of this prune is to ensure that expired files get deleted on a timely basis. A periodic prune is always a full prune. For a definition of full prune and a detailed discussion of pruning, see the PruneAmount property.

See Also



MemberOfGroups

Represents a collection containing the groups of which a given group or user is a member.

See Also



MetadataMergedScopeCacheMaxEntries

The maximum number of metadata merged scope caches to be retained in memory. The default is 20 caches.

Use of this property can assist you in preventing excessive memory usage on the Content Engine server. When a merged scope cache is created and the class descriptions are loaded in the cache, the names of the classes are mapped to the first instance of the class encountered in the ordering sequence of the object stores to be merged. As an example, let's say that a class in object store A is named X and has the same GUID as a class named Y in object store B. If you merge object stores A and B, the class name of the merged scope cache (A,B) will be X, whereas the class name of the merged scope cache (B,A) will be Y. As you can see from this example, specifying many different orders of merged object stores could result in an excessive number of merged scope caches being created, and can exceed the server's memory capacity. Set the value of this property to limit the number of metadata merged scope caches that can reside in memory.

See Also



MetadataTraceFlags

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

See Also



MimeType

Specifies the Multipurpose Internet Mail Extensions (MIME) format string of the content data carried by this document, annotation, or document classification action.

For Document objects, you can set the MimeType property for a specific document version while it is a reservation object (at creation time and on subsequent check-outs). However, every time you check in a document, its MimeType property value reverts to its system-assigned value unless you explicitly set it again.

For Annotation objects, you can set this property at any time.

For DocumentClassificationAction objects, the MimeType property specifies the type of content that a document must hold in order to allow it to be auto-classified; you can set this property at any time.

Each content element that is attached to a document or annotation has its own MIME type, which is specified by its ContentType property. If you do not specify the MimeType property for a document or annotation, it is automatically determined by the Content Engine according to the setting of each content element's ContentType property and the following logic:

MIME is a communications protocol that allows for the transmission of data in many forms, such as audio, binary, or video. A MIME format string consists of a content type, a content subtype, and an optional parameter in the following format: "MIME::content type/subtype[;parameter]". For example: "MIME::text/html". MIME defines the following content types:

The following MIME types are specific to FileNet:

See Also



MinimumRetentionDays

Specifies the minimum retention period in days.

See Also



MinorVersionNumber

Specifies the minor version number of this document version. A document's minor version number is set to 1 the first time that you check it in as a minor version and then incremented by 1 for each additional time that you check it in as a minor version. Note that if you check in a document as a major version, its minor version number will be reset to 0.

See Also



ModificationAccessRequired

Specifies the access rights that are required to change the value of a given property on the object instances on which the property occurs. To specify access rights, or combinations of access rights and levels, use the AccessRight and AccessLevel classes in the com.filenet.api.constants package. You can:

See Also



ModifiedProperties

A list of the symbolic names of the properties modified during a given event. Note that this property is only available when you retrieve the event object, for example, by calling the Factory fetchInstance method. This property is not available from the event object passed to the event action handler.

See Also



MyRealm

The current user's realm. The current user is the user under whose credentials RPCs are being performed.

See Also



N

Name

The name for this object.

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

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

See Also



NamePropertyIndex

Specifies the 0-based index of the PropertyDescription object in this ClassDescription object's PropertyDescriptions collection that serves as the name property for object instances of the class (usually resolves to the DisplayName property). If NamePropertyIndex is null, the class will not have a designated name property; in this case, the Name property of the object instantiation of the class will be set to the value of its Id property.

See Also



NeverDeleteClipsOrContent

Indicates whether a CenteraFixedContentDevice object prevents the deletion of Clips or Blobs on the Centera device (true) or not (false). If true, the provider never attempts to delete Clips or Blobs and all content is left completely intact on the Centera device. Note that normally this setting has no impact on enforcement of the retention period (the storage area honors the retention period and prevents deletion when appropriate).

See Also



NextRetryDate

Specifies the date and time that a retry will be attempted to process a queue item (pending action) on a target object. The value of this property is set by the server to indicate the time at which the server can retry the queued item. For newly added queue items or "dead" queue items (that is, those items which have no retries left), the value is null.

See Also



NoWorkDelay

Specifies the time in milliseconds that an import agent waits when there is no work.

See Also



NonPagedQueryMaxSize

The maximum size in rows of a non-paged query result set. This value cannot be overridden by an individual query.

See Also



NumImportAgents

Specifies the number of ImportAgent worker threads per object store and Image Services fixed content device.

See Also



O

ObjectSecurityCacheEntryTTL

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

For more information about this cache, see Security Caching.

See Also



ObjectSecurityCacheMaxEntries

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

For more information about this cache, see Security Caching.

See Also



ObjectStateRecordingLevel

Specifies the audit recording level of the source object for an event of type ObjectChangeEvent. (The source object is the object on which the event is fired.) The recording levels are ORIGINAL_AND_MODIFIED_OBJECTS (both the original, pre-event object and the modified, post-event object are recorded), MODIFIED_OBJECT (only the modified, post-event object is recorded), and NONE (no source objects are recorded). If MODIFIED_OBJECT is set, the event's OriginalObject property will be null. If NONE is specified, the event's OriginalObject and SourceObject properties will be null, and the event's ModifiedProperties property will be empty.

Note: Persisting audited source objects in a database can result in substantial consumption of large object (LOB) storage.

See Also



ObjectStore

An object representing the object store in which the object resides.

See Also



ObjectStoreId

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

See Also



ObjectStoreSchemaDB2

Specifies the default SQL script to use when creating object stores within a DB2 database.

You can customize the supplied default schema script and then submit your customized script when you call the Factory.ObjectStore.createInstance(domain, admins, users, schemaScript) method. Typical modifications to the default script include the distribution of the various tables, indexes, and Large Object (LOB) columns across different tablespaces. For more information, see "Working with Object Stores" in the Content Engine Java and .NET API Developer's Guide.

See Also



ObjectStoreSchemaMSSQL

Specifies the default SQL script to use when creating object stores within a Microsoft SQL Server database.

You can customize the supplied default schema script and then submit your customized script when you call the Factory.ObjectStore.createInstance(domain, admins, users, schemaScript) method. Typical modifications to the default script include the distribution of the various tables, indexes, and Large Object (LOB) columns across different tablespaces. For more information, see "Working with Object Stores" in the Content Engine Java and .NET API Developer's Guide.

See Also



ObjectStoreSchemaOracle

Specifies the default SQL script to use when creating object stores within an Oracle database.

You can customize the supplied default schema script and then submit your customized script when you call the Factory.ObjectStore.createInstance(domain, admins, users, schemaScript) method. Typical modifications to the default script include the distribution of the various tables, indexes, and Large Object (LOB) columns across different tablespaces. For more information, see "Working with Object Stores" in the Content Engine Java and .NET API Developer's Guide.

See Also



ObjectStores

Represents the collection of ObjectStore objects associated with a given FileNet P8 domain.

See Also



OptimizationInterval

The number of batches to index prior to performing an optimization on the indexing information. Setting the default value higher increases indexing throughput at the expense of search performance.

See Also



OriginalObject

The event's source object prior to the event. To get the source object at the time the event occurred, use get_SourceObject. To compare the two states of the source object, fetch the properties of the object returned by get_OriginalObject and get_SourceObject.

See Also



OriginalOrdinal

The ordinal number of the Verity collection if this collection was created prior to the Content Engine 4.0 release.

For objects indexed in this collection, an arithmetic function is performed on the object's GUID to map it to an ordinal number, indicating this ordinal number (the collection in which the object resides).

See Also



OutboundBatchSize

This property is not supported.

See Also



OutboundBusyWaitInterval

This property is not supported.

See Also



OutboundDispatcherEnabled

This property is not supported.

See Also



OutboundIdleWaitInterval

This property is not supported.

See Also



OutputFolder

Specifies the folder where the publication document is to be filed.

See Also



OutputFormat

Specifies the MIME type of output documents produced by the transformation engine when using this style template (for example, "text/html").

See Also



OutputLocation

The fully qualified path to use as the output location for trace logs (used only when the AppenderNames property value is the FileAppender class or a subclass. If unspecified or null, this property value defaults to the application server instance's working directory path appended with "/FileNet". The filename for the trace log is always "p8_server_trace.log", and the log4j layout pattern used is "%d %5p [%t] - %m%n".

Note: Because log4j creates directories on the fly, the only validation against a non-null value for this property is that the location resides within a valid directory.

See Also



Owner

Manages the security owner assigned to the object.

See Also



OwnerDocument

For a published document, contains a reference to the Document object representing the owner document associated with the published document. If this document is a publication and there is a cascade delete relationship with the source, then this property will specify the publication source document (the OwnerDocument and PublicationSource properties will reference the same document).

See Also



P

PDFMasterPassword

Specifies an encrypted master password for a PDF rendition. Because this property contains a password, it can only be set. (Attempting to retrieve this property will return a zero-length binary value.)

See Also



PDFUserPassword

Specifies an encrypted user password for a PDF rendition. Because this property contains a password, it can only be set. (Attempting to retrieve this property will return a zero-length binary value.)

See Also



PEConnectionPoints

A PEConnectionPointSet object containing the list of connection points (PEConnectionPoint instances) available in this P8 domain.

See Also



Parent

The Folder object for the folder that directly contains this folder.

See Also



ParentComponent

The Document object designated as the parent in a component relationship. The setting for the CompoundDocumentState property on this parent Document object must be COMPOUND_DOCUMENT. Also, you must have link rights (AccessRight.LINK) on the document.

See Also



ParentDocuments

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

See Also



ParentRelationships

A ComponentRelationshipSet collection object that contains the ComponentRelationship objects referencing this document as the child component document. The collection contains only those parent relationship objects for which the user has read access.

See Also



PartialResolutionChunkSize

The number of content queue items to be resolved using a single delete statement, when a batch is resolved in chunks.

See Also



PartnerObjectStore

This property is not supported.

See Also



PathName

The full path name of the folder.

See Also



PermissionDescriptions

A list of descriptions of permissions applicable to objects of the described class.

See Also



PermissionSource

Indicates the source of the given permission.

The source of access rights can be:

See Also



PermissionType

Specifies the type (right or level) of the described permission.

Valid types are single (that is, a single access right), level (a commonly used combination of access rights), default level (that is, the recommended level for new permissions), and inherited (relevant only to child objects of the parent object described by the permission).

See Also



Permissions

Manages the discretionary permissions assigned to the object.

See Also



PersistenceType

Specifies a PropertyPersistence constant that indicates whether a property can be made persistent (that is, have its state stored in a database). If a property can be made persistent, it must have either a dedicated column or a dedicated table in the database.

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

Name Value Description
NOT_PERSISTENT 0 Specifies that a property cannot be made persistent. If a property is defined as NOT_PERSISTENT, has a default value defined, and the Settability property of its property template has a value of PropertySettability.READ_ONLY, the property is considered to be a constant and will always return its default value for any instance of the property that is returned.
OWN_COLUMN 1 Specifies that the property has a dedicated column in the database and therefore can be made persistent.
OWN_TABLE 1 Specifies that the property has a dedicated table in the database and therefore can be made persistent. This setting applies only to multi-valued scalar (non-object) properties and causes the server to store a property's values into a custom table, which is generated by the server when its property template is first assigned to a class definition as a property definition. The name of this table is derived from the name of the corresponding property. Once it has been created, the same table will be used to store the property's values, regardless of the class to which the property is assigned.

See Also



PoolAddress

Specifies the Centera pool address that is passed to the FPPool class constructor as the PoolAddress parameter (which identifies the location of the Centera fixed content device). This pool address will be used when the Content Engine server is running within the site identified by the Site property of this object.

See Also



PreloadOnCreate

A value indicating whether the cache receives duplicates of any new content added to the main storage area. When true, and when content normally gets cached (because the cache status is OPEN, cache capacity has not been exceeded, etc.), content newly added to the main storage area also gets added to the cache area.

See Also



Prerequisites

Specifies a list of IDs corresponding to the prerequisite add-ons that must be installed prior to the installation of this add-on or upgrade add-on.

See Also



PreserveDirectPermissions

Determines whether direct access control entries (ACEs) are preserved on an object when a given security policy template or lifecycle policy is applied to the object. Direct ACEs are permissions that have been directly set on the object, not set through inheritance. If the value of this property is false, the object's original direct permissions are replaced by the permissions defined by the applied security policy template or lifecycle policy. Permissions inherited from the object's security parent are retained. If the value is true, the object's original direct permissions are preserved as well as its inherited permissions.

See Also



PrimaryId

The primary ID for this property definition, which is equal to the Id property of the property template on which this property definition is based.

Property definitions that exist on different classes but are derived from the same property template will all have the same PrimaryId property value. Because multiple property definitions can be created from the same property template and a property definition's Id property must be unique for every property definition in every class, a property definition's PrimaryId property will not be equal to its Id property. For a given property representation, the PrimaryId property has the following characteristics:

See Also



PrincipalCacheEntryTTL

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

For more information about this cache, see Security Caching.

See Also



PrincipalCacheMaxEntries

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

For more information about this cache, see Security Caching.

See Also



Priority

This property is no longer implemented. Although it is retained in the API for backward compatibility, use of this property will have no effect.

See Also



PrivilegedSettability

Specifies a PropertySettability constant, which indicates the settability of a property when an application has been granted privileged write access (AccessRight.PRIVILEGED_WRITE access right). Privileged write access gives an application the potential capability to set the Creator, DateCreated, DateLastModified, and LastModifier properties, which are normally read-only. The Settability property continues to indicate the property's settability for all other users.

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

Name Value Description
READ_ONLY 3 Indicates that a property is read-only; only the server can set its value.
READ_WRITE 0 Indicates that a property is read/write; you can set its value at any time.
SETTABLE_ONLY_BEFORE_CHECKIN 1 Indicates that you can only set the value of a property before you check in the object to which it belongs.
SETTABLE_ONLY_ON_CREATE 2 Indicates that you can only set the value of a property when you create the object to which it belongs. Once you save the object for the first time, the property's value cannot be changed.

See Also



ProgId

A String that specifies the fully qualified name of the Java™ class that executes when the event occurs.

See Also



ProperSubclassPropertyDescriptions

Specifies a PropertyDescriptionList object containing a collection of the property description objects belonging to all of the subclasses of the class described by this ClassDescription object.

See Also



PropertyDefaultBinary

Specifies the default value for a property that returns a BINARY data type.

See Also



PropertyDefaultBoolean

Specifies the default value for a property that returns a BOOLEAN data type.

See Also



PropertyDefaultDateTime

Specifies the default value for a property that returns a DATE data type.

See Also



PropertyDefaultFloat64

Specifies the default value for a property that returns a DOUBLE data type.

See Also



PropertyDefaultId

Specifies the default value for a property that returns a GUID data type.

See Also



PropertyDefaultInteger32

Specifies the default value for a property that returns a LONG data type.

See Also



PropertyDefaultObject

Specifies the default value for a property that returns an OBJECT data type.

See Also



PropertyDefaultString

Specifies the default value for a property that returns a STRING data type.

See Also



PropertyDefinitions

Specifies a PropertyDefinitionList object containing an ordered collection of all of the property definitions belonging to this class definition.

See Also



PropertyDescriptions

Specifies a PropertyDescriptionList object containing an ordered collection of all of the property descriptions belonging to this class description.

See Also



PropertyDisplayCategory

Specifies a string that is used to group related properties together for display and sorting purposes.

See Also



PropertyDisplayName

Specifies the display name of the property that caused the active marking to be applied to the object. Call get_PropertyDisplayName on the ActiveMarking interface to retrieve the value of this property. The returned value corresponds to the display name of the property that is designated as a marking property for a given object. As an example, if a Document object has a property named "foo" and that property is identified as a marking property, then the list of active marking instances for the document will have a property display name that corresponds to the display name of the "foo" property.

See Also



PropertyIdentity

Specifies the identity of the external property described by this external property description or external property alias.

For ExternalPropertyDescription objects only, this string is immutable and is unique within the external class to which the external property description belongs.

See Also



PropertyMap

A String holding the list of mappings between the properties of a versionable-related object and workflow data fields. For example, you might want to map a document's Creator property with Employee Name, if that data field exists in the workflow definition. The workflow data fields you specify in the property map must be designated as launch step parameters in the workflow definition.

See Also



PropertyMaximumDateTime

Specifies the maximum value for a property that returns a DATE data type.

See Also



PropertyMaximumFloat64

Specifies the maximum value for a property that returns a DOUBLE data type.

See Also



PropertyMaximumInteger32

Specifies the maximum value for a property that returns a LONG data type.

See Also



PropertyMinimumDateTime

Specifies the minimum value for a property that returns a DATE data type.

See Also



PropertyMinimumFloat64

Specifies the minimum value for a property that returns a DOUBLE data type.

See Also



PropertyMinimumInteger32

Specifies the minimum value for a property that returns a LONG data type.

See Also



PropertySelectionBinary

Specifies a BinaryList object that contains the list of binary values that can be assigned to the property described by this PropertyDescriptionBinary object.

See Also



PropertySelectionsBoolean

Specifies a BooleanList object that contains the list of Boolean values that can be assigned to the property described by this PropertyDescriptionBoolean object.

See Also



PropertySelectionsDateTime

Specifies a DateTimeList object that contains the list of DateTime values that can be assigned to the property described by this PropertyDescriptionDateTime object.

See Also



PropertySelectionsFloat64

Specifies a Float64List object that contains the list of Double (Float64) values that can be assigned to the property described by this PropertyDescriptionFloat64 object.

See Also



PropertySelectionsId

Specifies an IdList object that contains the list of GUID string values that can be assigned to the property described by this PropertyDescriptionId object.

See Also



PropertySelectionsInteger32

Specifies an Integer32List object that contains the list of integer values that can be assigned to the property described by this PropertyDescriptionInteger32 object.

See Also



PropertySelectionsObject

Specifies a DependentObjectList object that contains the set of Content Engine objects that can be assigned to the property described by this PropertyDescriptionObject object.

See Also



PropertySelectionsString

Specifies a StringList object that contains the list of string values that can be assigned to the property described by this PropertyDescriptionString object.

See Also



PropertyTemplate

Contains an object instance of a PropertyTemplate subclass (PropertyTemplateBinary, for example) that specifies the property template on which this property definition is based.

See Also



PropertyTemplates

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

See Also



ProtectedPropertyCount

Specifies the number of property definitions that can neither be moved nor removed from this class definition.

See Also



ProviderID

Specifies an ID string that represents the Java™-based event handler associated with this publish style template (for example, PublishRequestHTMLHandler or PublishRequestPDFHandler).

See Also



PruneAmount

The percentage amount of cache content to delete during a cache prune action. The calculated amount determines the number of files to delete (based on the PruneThresholdContentElements property) and also the total size of files to delete (based on the PruneThresholdSizeKBytes property).

Specifically, a prune action begins by calculating two prune quotas: a number quota and a size quota. These quotas apply to each directory. The quota calculation takes into account the prune amount percentage (as specified by the PruneAmount property), the prune thresholds (as specified by the PruneThresholdContentElements and PruneThresholdSizeKBytes properties), the current amount of content in the cache (as indicated by the ContentElementCount and ContentElementKBytes properties), and the number of cache directories. Specifically:

For example, for the number quota, suppose when the prune action begins the cache contains 100,100 files, the prune threshold is 100,000 files, the prune percentage is 5%, and the cache has 529 directories. The prune target, in this case, is 95,000: 100,000 minus 5,000 (5% of 100,000). The quota for each directory equals 10: 100,100 minus 95,000, divided by 529 (rounded up). The size quota gets calculated in a similar manner.

A full prune action consists of two phases: an initial prune and a partial prune. An initial prune deletes all abandoned and expired files and also generates an LRU (least-recent-use) list for each directory. All files in the directory are put in ascending time-of-last-use order on this list; the first file listed has been accessed less recently than any other file (in other words, it is the oldest). A partial prune processes old files in LRU list order. As a file can be retrieved from the cache at any time--and thus might be younger than it was at LRU list generation time--a partial prune always checks the time-of-last-use for a file before deleting it. It skips any file with a time-of-last-use more recent than the LRU list creation time. The partial prune continues down the LRU list in this manner, taking files off the list as they are either deleted or skipped.

All old and expired files deleted in a directory count towards the quotas for that directory, although the quotas only control the number of old files deleted during the partial prune (as all expired files get deleted during the initial prune). Note that in a full prune the prune quotas might be satisfied during the initial prune phase. In this case, the second phase of the full prune--the partial prune--does not occur. Also, regardless of when the prune quotas might be satisfied during the course of the prune, an initial prune always generates a new LRU list.

For an overview of pruning and a discussion of the categories of files deleted during a prune, see the ContentCacheArea interface.

See Also



PruneThresholdContentElements

The minimum number of content elements in the cache area sufficient to trigger a cache prune action. Specifically, a background process periodically checks whether the content element count statistic (as indicated by the ContentElementCount property) has exceeded this prune number threshold, or whether the content element size statistic (as indicated by the ContentElementKBytes property) has exceeded the prune size threshold (as specified by the PruneThresholdSizeKBytes property). If so, a mandatory prune action gets launched; its purpose is to ensure that cache content remains under the prune threshold levels.

With respect to any given directory, a mandatory prune can be either a full or partial prune (and so, with respect to the cache as a whole, a mandatory prune can be a mixture of full and partial prunes). It is a full prune only when the LRU list needs to be generated. Specifically, it is a full prune in these circumstances: this is the first pruning action for a new cache, and consequently no LRU list yet exists; the LRU list has expired (it is older than 1 day); or a previous prune action exhausted the LRU list. (Note that a partial prune can exhaust the LRU list without satisfying the prune quotas.)

For an overview of cache pruning, see the ContentCacheArea interface. For definitions of pruning terms (full prune, partial prune, LRU list, etc.) and a detailed discussion of pruning, see the PruneAmount property.

Note that, as indicated above, the PruneThresholdSizeKBytes property defines another pruning threshold.

See Also



PruneThresholdSizeKBytes

The minimum size of all content elements in the cache area sufficient to trigger a cache prune action (in kilobytes). Note that the PruneThresholdContentElements property defines another pruning threshold. For details on the prune action that occurs in response to prune threshold crossings, see that property.

See Also



PublicKey

Specifies the public key used for encrypting/signing data (such as passwords and other sensitive properties) sent in requests to the domain. For more information, see the Encryption class.

See Also



PublicationDocument

Specifies the document to use if republishing an existing document and the option to version the current document is set.

See Also



PublicationInfo

Specifies the parameters (formatted as XML) that were used to publish a document. The parameters, which are used to republish the document, include the original output folder ID, style template ID, publish template ID, and publish template version series ID. For example:

<publicationinfo>
  <styletemplateid>{14917CF3-4D5F-499D-BA38-8E010199745E}</styletemplateid>
  <publishtemplateid>{4D696690-EEBB-4341-9FE7-A8F715BAE96D}</publishtemplateid>
  <pubtemplversionseriesid>{459A0D5A-5B44-4AD1-B15C-91D7B773B3DD}</pubtemplverseriesid>
  <outputfolderid>{4EF26F2E-61D8-47FD-8201-EE81C3AA75FA}</outputfolderid>
</publicationinfo>

If the document is not a publication, the property is empty.

See Also



PublishRequestType

Specifies an integer that indicates the type of publish request. This property is used internally by the Content Engine API.

See Also



PublishStyleTemplate

Contains a reference to the PublishStyleTemplate object associated with this publish request.

See Also



PublishTemplate

Contains a reference to the PublishTemplate object associated with this publish request. If this property is set, the PublishRequest object is for a publish operation. To perform a republish operation, the PublicationDocument property must be set and this property must be null.

See Also



PublishTraceFlags

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

See Also



PublishingStatus

Specifies the status (complete, deleting, in error, in queue, or in work) of a publish request.

See Also



PublishingSubsidiaryFolder

Specifies a folder which contains the subsidiary documents of an HTML publication (for example, image, audio, and style sheet files).

See Also



Q

QueriedObject

The queried Document object that provided the content for the full-text search.

See Also



QueryPageDefaultSize

The default size in rows of a query page in a result set.

See Also



QueryPageMaxSize

The maximum size in rows for a query page in a result set. This value cannot be overridden by an individual query.

See Also



QueryText

The original query text from which the query was generated.

See Also



QueueItemDatabaseTimeout

Specifies the database transaction timeout in seconds for queue items execution.

See Also



QueueItemMaxDispatchers

Specifies the maximum number of dispatchers that can run simultaneously.

For the PublishingConfiguration object, this property specifies the maximum number of publish request handler instances.

See Also



QueueItemRetryCount

Specifies the maximum number of retries that will be attempted to process a queue item.

For the PublishingConfiguration object, the queue item is a publish request.

See Also



QueuedObject

The object that is the subject of the queued operation. For example, this may be a Subscription object that caused a given asynchronous event to be queued.

For the AsyncUpgradeQueueItem interface, this property is for internal use only.

See Also



R

Rank

The level of importance (rank) assigned to documents returned by a full-text query. This a value from 0.0 to 1.0, where the greater value indicates a better match.

See Also



ReferencingActions

A collection of Action-based objects referencing this object.

See Also



ReflectivePropertyId

Specifies the Id property of the reflective property for this object-valued property. A reflective property is a property that you can create in order to constrain a multi-valued, object-valued property in another class to return specific objects of a given class. If the ReflectivePropertyID property of an object-valued property of multiple cardinality is not set, the property will return all objects that have been instantiated from its required class.

For example: given an object-valued property in class A, its reflective property is an object-valued property in class B whose required class is class A. In order for an object-valued property in objects instantiated from class A to return specific objects, you must set its reflective property in each object of class B that you wish it to return.

See Also



RegionKey

The encryption key for this isolated region.

The region key is used to generate IBM FileNet P8 Identity Tokens for use between Process Engine applications and Process Engine servers. In the IBM FileNet P8 4.5 release, this key is generated by Content Engine, based on the RegionPassword property. In a future release, Process Engine will generate the isolated region key using the FIPS 140-2 compliant Advanced Encryption Standard (AES) algorithm. The key is then passed to the Content Engine and the value is stored on the Content Engine server in the GCD, encrypted with the Content Engine's master key.

Because the datatype is binary, you should set the RegionKey property value through a secure channel (Secure Socket Layer, or SSL). If the value is set, retrieval of the region key returns a zero-length value; otherwise, returns null.

Note: Support for the isolated region key generation using a password will be discontinued in a future release.

See Also



RegionPassword

The isolated region password used to generate a region key for this isolated region. The isolated region key is persisted on the Content Engine server, but the password itself is not persisted anywhere. If this property value is retrieved, the client will get a zero-length value. Setting or resetting the password causes the region key to be regenerated.

Note that the region key is used to generate P8 Identity Tokens for use between Process Engine applications and Process Engine servers. The region password that is entered for an isolated region must exactly match the region password that is entered when creating or editing the isolated region through the Process Engine admin tools. If these two passwords (and the region keys that are generated from them) do not match exactly, then Process Engine authentication will fail.

The datatype is binary, because the password is encrypted before it goes across the wire.

See Also



ReleasedVersion

Specifies a document version that represents the latest released version associated with this document or version series. A released version is a major version that has a VersionStatus property value of RELEASED. Note that only one document version at a time in a given version series can be in the released state.

See Also



RenameFileRetryAttempts

The number of times a worker thread is to attempt renaming and moving a content file from the inbound directory to its permanent location in the storage area. Also, the number of milliseconds that the thread is to wait after each failed attempt before making another renaming attempt. If all attempts fail, the thread returns the item associated with the content file to the content queue for future processing.

See Also



RenditionEngineConnection

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

See Also



RenditionEngineConnections

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

See Also



RenditionEnginePassword

Specifies an encrypted password for this Rendition Engine connection.

See Also



ReplicableDirection

Specifies the direction in which instances of the external class described by this external class description can be replicated.

See Also



ReplicationData

Specifies provider-specific data for this external replica object.

See Also



ReplicationGroup

Specifies a ReplicationGroup object representing the replication group to which this replicable object belongs.

See Also



ReplicationGroups

This property is not supported.

See Also



ReplicationMode

This property is not supported.

See Also



ReplicationOperation

This property is not supported.

See Also



ReplicationParticipants

This property is not supported.

See Also



ReplicationStatus

This property is not supported.

See Also



ReplicationTraceFlags

This property is not supported.

See Also



RequiredClass

Specifies the ClassDescription object describing the class or superclass of which an object returned by the object-valued property described by this PropertyDescriptionObject object must be an instance.

See Also



RequiredClassId

Specifies the Id property value of the ClassDescription object describing the class or superclass of which an object returned by the object-valued property described by this PropertyDefinitionObject object must be an instance. Although there are no restrictions on the type of class that you can specify for a RequiredClassId property, if you set it to a class that describes a dependent object, you will not be able to set the property described by this PropertyDefinitionObject object to that dependent object. This is because you cannot set a custom object-valued property to a dependent object; unlike a system object-valued property, a custom object-valued property can hold independent objects only.

See Also



RequiresUniqueElements

Specifies whether the values of a multi-valued property must be unique (true) or not (false).

See Also



Reservation

Specifies the reservation object of this object's version series, which has a VersionStatus property value of RESERVATION. A reservation object is created by the server when you check out a document, which you can modify and check in as a new version of that document.

See Also



ReservationType

Specifies a ReservationType constant that explicitly indicates the type of this document reservation (collaborative or exclusive) or whether its reservation type is the same as the default object store setting.

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

Name Value Description
COLLABORATIVE 16 Indicates a collaborative reservation, which is a reservation that any user with the appropriate permissions can check in, modify, or delete.
EXCLUSIVE 32 Indicates an exclusive reservation, which is a reservation that only the owner can check in, modify, or delete.
OBJECT_STORE_DEFAULT 0 Indicates that the reservation type is the same as the default reservation type for the object store, which is specified by the DefaultReservationType property.

See Also



ResetLifecycleOnCheckin

Specifies whether to reset the lifecycle state of the new checked-in version of a document to the initial state of its associated document lifecycle policy (true) or not (false). If the ResetLifecycleOnCheckin property of a document's associated DocumentLifecyclePolicy object is set to false, the lifecycle state of the document will remain the same from one version to the next unless you explicitly change it using the document's changeState method.

See Also



ResourceStatus

Contains a ResourceStatus object, which specifies the availability status of a storage or index area. The status value can be any one of the following:

Note: When the ResourceStatus value is UNAVAILABLE, the indexer creates a new collection and completes any pending index requests using the new collection.

The Content Engine supports the following automatic transitions between status values:

An area's status can also be changed manually as allowed by the following rules:

See Also



ResourceString

Specifies a string that contains provider-specific information about a fixed content device.

For Image Services, this property allows you to specify the Image Services document class name for content that is stored on an Image Services fixed content device. This value will override the DefaultISDocumentClass property on the associated IMFixedContentDevice object. For example:

x-filenetfsrs:?ISDocClassName=SomeDocClassName

See Also



RestrictMembershipToConfiguredRealms

Restricts a group membership search to within the realms configured in FileNet Enterprise Manager.

By default (that is, when the property value is false), the Content Engine Server automatically traces cross-realm group membership (also called cross-domain group membership in Active Directory). If it reaches a realm that is not configured in FileNet Enterprise Manager, the Content Engine server returns a "Realm not found" error and group membership search processing stops. However, if the property value is true when this situation occurs, the Content Engine server logs an informational message to the Content Engine server error log and the group membership search continues.

Note: This property is not supported for the Windows Active Directory Application Mode (ADAM) directory service provider. This is because ADAM does not support cross-realm group memberships (cross-partition memberships, in ADAM terminology).

See Also



RetentionPeriod

Specifies when a content element will expire, so that it can be deleted from a storage area object. A positive value represents the number of minutes the content element must be retained. Other possible values, as enumerated in the RetentionPeriod class, are:

See Also



RetrievalName

Specifies the path to the file from which the content data for this document or annotation content element (represented by a ContentTransfer object) can be retrieved for editing. The complete path (including the file name) can contain up to 2083 characters; the file name itself can be up to 255 characters long.

See Also



RetrievalRetryAttempts

Content retrieval retry attempts (used when attempting to locate content before roll-forward is applied).

See Also



RetryCount

Specifies the number of remaining attempts to process the queue item. When the retry count reaches 0 for a queue item, the item is considered "dead" and no further retries are attempted. If you want to retry a "dead" queue item, reset the retry count from 0 to a positive number. The range of valid values is 0 to 16.

See Also



ReturnNameAsDN

Specifies whether to return the user or group name in Distinguished Name (DN) format for Active Directory Service provider. By default, the Active Directory Service provider returns the user and group names in UPN format. If this property is set to true, the service provider returns the names in DN format, which is consistent with other types of directory service providers.

See Also



RollFwdBatchRetryAttempts

Roll-forward batch retry attempts (before discarding the batch).

See Also



RootClassDefinitions

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

See Also



RootDirectoryPath

The fully qualified path to the root directory for this storage area. The path can be a local mount point, a local path, or a UNC path.

The following information is specific to the use of VerityIndexArea.RootDirectoryPath:

See Also



RootFolder

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

See Also



S

SSITraceFlags

Specifies the trace flags applied to the classes in the SSI (Single-document Storage Interface) subsystem, an interface between the Content Engine and FileNet Image Services. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.

See Also



ScriptText

The script text of event procedures that are executed when an Action-based object's events are raised.

NOTE: For this release, scripting languages are not supported for event procedures. Text in the ScriptText property will be ignored.

See Also



ScriptType

Specifies the language in which the pre- or post-import scripts are written. This property's value must be set to JavaScript.

See Also



SearchCrossForestGroupMembership

Specifies whether the Active Directory Service provider performs cross-forest group membership searches. The default is false. To enable cross-forest group membership searches, set this property to true.

See Also



SearchDynamicGroup

This property is not supported.

See Also



SearchServersToAttach

The number of servers from the listing in the VerityIndexArea.VeritySearchServers property that will be attached to a newly created collection. The servers chosen will be those with the fewest collections already attached to them.

See Also



SearchTraceFlags

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

See Also



SecurityDescCacheMaxEntries

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

See Also



SecurityFolder

Indicates a Folder object from which the object inherits security (a security parent).

This value is indirectly set when DefineSecurityParentage is specified as the value of the defineSecurityParentage parameter for the Folder.file method. The value, in this case, is the folder in which the object is filed.

You can designate multiple security parents for an object by using one or more object-valued properties and setting the SecurityProxyType value for these properties to INHERITANCE.

See Also



SecurityParent

Deprecated. Use SecurityFolder instead.

Specifies the object from which a given object inherits security. The value of this property is a ReferentialContainmentRelationship (or DynamicReferentialContainmentRelationship) that represents the object from which security is inherited.

An object can inherit its permissions from its security parent. For example, a Document object can inherit the permissions of the Folder in which it is filed. A Folder object always inherits its permissions from its parent folder. An object's security parent is reflected in the value of its SecurityParent property. You can explicitly set the security parent of an object at the time it is filed into a folder by specifying the defineSecurityParentage parameter of the Folder.file method.

See Also



SecurityPolicies

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

See Also



SecurityPolicy

Specifies the SecurityPolicy associated with the given object. The SecurityPolicy contains one or more SecurityTemplate objects that define the permissions to assign to a given object. A security template can be one of two types: a VersioningSecurityTemplate or an ApplicationSecurityTemplate. A VersioningSecurityTemplate defines permissions that will be automatically assigned to the object when its version state changes. An ApplicationSecurityTemplate defines permissions that will be assigned to the object upon an explicit call to do so by an application program. For information on each of these types of templates, refer to their interface descriptions.

Assigning a security policy to a Document, CustomObject, or Folder object (or their subclasses) is optional.

See Also



SecurityProxyType

For internal use only. Do not use this property; it is intended for internal use only by the Content Engine.

This property specifies the manner in which setting a value for the described object-valued property establishes a security proxy for the object. Valid values are FULL and NONE. For descriptions of each value, see SecurityProxyType.

See Also



SecurityTemplates

Specifies a SecurityTemplateList object that contains a collection of the security templates associated with a given Security Policy object.

See Also



SecurityTraceFlags

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

See Also



ServerInstances

Represents a collection of ServerInstance objects for a given virtual server.

See Also



Settability

Specifies a PropertySettability constant, which indicates when the value of a property can be set: For special system property cases in which privileged write access may be granted, the PrivilegedSettability property governs the property's settability for users who have AccessRight.PRIVILEGED_SETTABILITY access, while the Settability property continues to indicate the property's settability for all other users. See the description of the PrivilegedSettability property for these special cases.

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

Name Value Description
READ_ONLY 3 Indicates that a property is read-only; only the server can set its value.
READ_WRITE 0 Indicates that a property is read/write; you can set its value at any time.
SETTABLE_ONLY_BEFORE_CHECKIN 1 Indicates that you can only set the value of a property before you check in the object to which it belongs.
SETTABLE_ONLY_ON_CREATE 2 Indicates that you can only set the value of a property when you create the object to which it belongs. Once you save the object for the first time, the property's value cannot be changed.

See Also



ShortName

The short name of a given group or user.

An example of a user's short name is "test1", or a group's short name might be "Managers". The short name format does not require any other qualifying information, such as domain. See the DistinguishedName property on the User or Group interface to compare the short name format to the distinguished name (DN) format.

See Also



SingleItem

The single Document, Folder, Annotation, or CustomObject object to be indexed.

See Also



Site

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

See Also



SiteSettings

Specifies the SiteSettings objects associated with a fixed content device. Site settings provide site-specific, configuration value overrides. For each fixed content device type with settings that can be overridden, a corresponding subclass of SiteSettings is defined with properties that, if populated, will override the corresponding properties of the same name on the fixed content device object.

For an EMC Centera fixed content device, this property allows the PoolAddress property to be different, depending on the site in which the Content Engine server is running. If the Content Engine server is running in a site that does not correspond to one of the SiteSetting objects, then the PoolAddress property on the CenteraFixedContentDevice object is used as the default.

For a FileNet Image Services fixed content device, this property allows the CSMCache property to be different depending on the site in which the Content Engine server is running. If the Content Engine server is running in a site that does not correspond to one of the SiteSetting objects, then the CSMCache property on the IMFixedContentDevice object is used as the default.

For a NetApp SnapLock fixed content device, there are currently no properties that may be customized for a site.

See Also



Sites

A collection of Site objects for this domain. Each element of the collection represents a geographical area in the domain.

See Also



SnapLockPassword

Specifies the encrypted password for the security principal identified by the SnapLockUserName property.

See Also



SnapLockUserName

Specifies the security principal used to connect to a remote SnapLock device.

See Also



SourceClassId

Class ID of the object that is the subject of this event.

See Also



SourceDocument

Specifies the source document for a published document.

See Also



SourceObject

The event's source object at the time the event occurred. Note that the state of the object may be different from its prior or current state. To get the state of the source object prior to the event, use get_OriginalObject on subclasses of ObjectChangeEvent that provide this method.

See Also



SourceObjectId

Id of the object that is the source of an ObjectChangeEvent-based event. You can use this property to identify an object if it no longer exists in the object store.

See Also



SourceRepositoryName

The name of the external (non-FileNet-P8) repository as known to the IBM Content Integrator instance.

CFS requires and expects this external repository to have a document model compatible with the FileNet P8 model. In particular, CFS requires that document content within an external repository not change, and locks down documents, as necessary, to enforce this requirement. (For an overview of the properties needed to implement a document lockdown, see the IICEFixedContentDevice interface.) In addition to this requirement, CFS and the Content Engine expect the version order for a document to be unchanging. (If the external repository does not support document versioning, CFS considers each version series to consist of one version.) The consequences of violating this expectation by federating a version series with a non-immutable version order include the following:

For more information on CFS document importing, see the CFSImportAgentConfiguration interface.

See Also



StagingAreaPath

Specifies a file system directory path that will be used to store content elements prior to uploading them to a fixed content device.

See Also



StateName

Specifies the name of this lifecycle state 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. If this lifecycle state becomes a document's current lifecycle state, the server sets the document's CurrentState property to the value of this property.

See Also



StatusDescription

Provides a description of the publishing status for this publish request.

See Also



StorageArea

Specifies the storage area for a content-carrying object.

See Also



StorageAreas

Specifies the collection of all storage areas.

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

See Also



StorageLocation

Specifies the storage location for an object's content. This property is deprecated in FileNet P8 4.0 and is only set in upgraded object stores. It has been replaced by the StorageArea property.

See Also



StoragePolicies

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

See Also



StoragePolicy

Specifies the document's storage policy, which identifies the set of available storage areas that are considered equivalent based on common, user-specified criteria. Assigning a storage policy to a document is the recommended method of selecting a storage area. The alternative is to directly assign the storage area (specify the StorageArea property).

When a document is created, the order of precedence for setting the storage on the Document instance is (from highest to lowest):

The default ClassDefinition for a document sets the StorageArea to "Database Storage Area" and the StoragePolicy to "All Storage Areas". Therefore, if you create a new Document instance of the default Document ClassDefinition with only the StoragePolicy property set, the document will use the class default for the StorageArea property (Database Storage Area).

To avoid this situation, you must set the instance value for the document's StorageArea property to null. Because the instance value for StorageArea is set, but has no value, the StoragePolicy property will be evaluated and used.

In general, storage policies should be used to allow administrators to properly administer their storage systems. They can assign multiple storage areas to be load balanced, and also assign standby storage areas to be used if any of the current storage areas become full.

See Also



StyleTemplate

Contains a reference to the PublishStyleTemplate object associated with this publish template. If this property is null, then the publish template is for a copy operation; otherwise, it's for a transformation operation. The PublishStyleTemplate object's OutputFormat property will determine the type of transformation (for example, HTML or PDF).

See Also



SubFolders

A FolderSet collection object containing the Folder objects for the directly-contained child folders of this Folder. Any referentially-contained child folders are not included in the collection.

See Also



Subject

The suggested subject prefix for the workflow subscription.

See Also



SubjectCacheEntryTTL

Specifies the Time-To-Live (TTL) in seconds for entries in the subject cache. The default is one hour. Once the TTL has elapsed, cached information that has become stale is discarded and fresh data is obtained.

See Also



SubjectCacheMaxEntries

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

See Also



SubmittedCount

The number of objects that currently have been submitted for indexing. This value is incremented as new requests are submitted to index additional objects.

See Also



SubscribedEvents

A list of objects specifying the events to which the subscription applies. When you create a subscription, you set this property to a SubscribedEventList collection, a list of objects representing the system and custom events to which to subscribe.

See Also



SubscriptionTarget

The target object of a Subscription-based object(ClassSubscription, ClassWorkflowSubscription, InstanceSubscription, InstanceWorkflowSubscription). You set the property with an a Subscribable object, then specify the property when you create the Subscription-based object.

For a ClassSubscription or ClassWorkflowSubscription object, set the value of the SubscriptionTarget property to a SubscribableClassDefinition object or subclass that specifies a type of Content Engine class (for example, Document or Folder). This means that any instance of the class, whether it currently exists in the persistent store or you create a new instance, will, when acted upon, cause one or more of the EventAction object's events to be raised.

For an InstanceSubscription or InstanceWorkflowSubscription object, set the value of the SubscriptionTarget property to a specific Subscribable object. This means that only this currently instantiated object, when acted upon, causes one or more of the EventAction object's events to be raised. If the object is a VersionSeries object, the event is raised when a version in the version series is acted upon.

See Also



Subscriptions

A collection of the subscriptions associated with this object.

See Also



SubsystemConfigurations

A list of subsystem configuration objects that reflect parameters of the configured subsystems.

See Also



SuperclassDefinition

Specifies the ClassDefinition object that defines the immediate superclass of the class defined by this class definition.

See Also



SuperclassDescription

Specifies the ClassDescription object that describes the immediate superclass of the class described by this class description.

See Also



SuperclassIdentity

Specifies the identity of the immediate superclass of the class described by this external class description. This property can be null if the repository does not have hierarchical classes or if the superclass of the described class is not a replicable class and is therefore absent from the ExternalClassDescriptions collection of the external repository.

See Also



SuperclassPropertyCount

Specifies the number of property descriptions contained in the class description that describes the immediate superclass of the class described by this class description. This value is equal to the number of properties inherited by a subclass from its superclass.

See Also



SupersededAddOnIds

The IDs of AddOn objects superseded by this AddOn.

Although present on the AddOn object and, by inheritance, the UpgradeAddOn object, this property has no use on the UpgradeAddOn object..

A newer version AddOn must specify in this property the IDs of the prior version AddOn objects that it functionally replaces, allowing an application with a dependency on that replaced (superseded) functionality to determine whether the functionality is available through the superseding AddOn. (See also the isAddOnInstalled helper method.)

See Also



SymbolicName

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

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

For property template objects, changing the symbolic name of a property template for a string-valued property that has been enabled for full-text indexing (IsCBREnabled property set to true) will require re-indexing of all objects containing that property. If you do not re-index, full-text searches on this property will fail to find any objects.

See Also



T

TSMApplicationType

A string, such as "FileNetP8", that identifies the application type of the client (Content Engine server) to the IBM® Tivoli® Storage Manager server.

See Also



TSMArchiveProtectionFlag

Specifies whether data retention protection is enabled on the IBM® Tivoli® Storage Manager (TSM) server (true) or not (false). This property corresponds to the ENABLEARCHIVERETENTIONPROTECTION option in a TSM options file and must match the data retention protection setting on the TSM server.

See Also



TSMCompressionFlag

Specifies whether files will be compressed before they are sent to the IBM® Tivoli® Storage Manager (TSM) server (true) or not (false). This property corresponds to the COMPression option in a TSM options file.

See Also



TSMConfigurationFilesShare

The full path of the root directory that contains the configuration options files for the IBM® Tivoli® Storage Manager (TSM) server. This directory must already exist and must be shared so that the Content Engine system user has read/write access. You should not modify these configuration options files directly; they are written to by the Content Engine server whenever various TivoliFixedContentDevice object properties are changed. Because the TSM server cannot run if these files are missing or damaged, you should back them up frequently.

See Also



TSMDSMIDirectory

If this property is set, it indicates that the Content Engine (CE) server is connected to the IBM® Tivoli® Storage Manager (TSM) server as a UNIX TSM client and specifies the full path of the client directory containing the dsmtca and dsm.sys files. Otherwise, if this property is not set, it indicates that the CE server is connected to the TSM server as a Microsoft® Windows® TSM client.

See Also



TSMFilespaceName

The name of the file space used by the client node (Content Engine server) to connect to an IBM® Tivoli® Storage Manager (TSM) server. A file space maps a TSM client node to a particular file system on the client machine. The file space name must begin with a forward slash (“/”).

See Also



TSMManagementClasses

A collection of the CmTivoliManagementClass management classes associated with a TivoliFixedContentDevice class. Each management class represents a specific retention setting, which consists of a retention scheme type and a retention period, that can be applied to an IBM® Tivoli® Storage Manager server.

See Also



TSMMinimumRetention

The minimum number of days to retain an object that has been archived with an IBM® Tivoli® Storage Manager server before it is deleted. For management classes that represent an event retention scheme, this property determines the length of the retention period; otherwise, this property is ignored.

See Also



TSMMountWaitDuration

This property is not supported.

See Also



TSMNodeName

The name of the client node (Content Engine server) to connect to the IBM® Tivoli® Storage Manager (TSM) server. All Content Engine objects that are archived on the TSM server will be accessed using this client node name. The client node must be configured to have proper read/write access and must be allowed to make multiple connections to the TSM server.

See Also



TSMOptions

A string containing configuration options that are passed to the IBM® Tivoli® Storage Manager (TSM) server by the TSM client (Content Engine server). These configuration options override the settings specified in the TSM options files. This string is not normally used and can contain P8-specific data that is not passed to the TSM server.

See Also



TSMOwnerName

The owner name for controlling access to the Content Engine objects that are archived using the IBM® Tivoli® Storage Manager server. This property is included for legacy reasons and is normally left blank.

See Also



TSMPassword

The password of the client node (Content Engine server) that connects to the IBM® Tivoli® Storage Manager server.

See Also



TSMPort

The port number of the IBM® Tivoli® Storage Manager (TSM) server. This property corresponds to the tcpport option in a TSM options file.

See Also



TSMRetentionInitiation

Specifies the type of retention scheme for a management class: chronological or event. The setting of this property determines how the retention periods specified by the TSMRetentionPeriod and TSMMinimumRetention properties will be interpreted.

This property can have one of the following values:

See Also



TSMRetentionPeriod

The number of days to retain a Content Engine object that has been archived with an IBM® Tivoli® Storage Manager server before it is deleted. For management classes that represent a chronological retention scheme, this property determines the length of the retention period; otherwise, this property must be set to 0.

See Also



TSMServerAddress

The IP address or computer name of the IBM® Tivoli® Storage Manager (TSM) server. This property corresponds to the TCPSERVERADDRESS option in a TSM options file.

See Also



TSMWriteBufferSize

The buffer size, in bytes, to use when transferring content data from the Content Engine to the IBM® Tivoli® Storage Manager server.

See Also



TableDefinition

The TableDefinition object for the database table in which this ClassDefinition or PropertyDefinition object resides.

See Also



TableDefinitions

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

See Also



TableName

The name assigned to the table.

See Also



Tail

An IndependentlyPersistableObject instance that participates in a binary relationship as the logical tail between two objects.

For a DynamicReferentialContainmentRelationship or ReferentialContainmentRelationship object, this is always a Folder object.

For a Link object, this can be any subclass of IndependentObject.

See Also



TargetAccessRequired

Contains a bitmask specifying the required access to an object that is intended as a target (referenced value) for a given object-valued property. This property may be one or more values of the AccessLevel or AccessRight enumerations.

A PropertyDefinitionObject defines object-valued properties as part of class definitions. Its TargetAccessRequired property specifies the access level that the caller must be granted by the target object in order to assign it as the value of the object-valued property being defined. To obtain the value of the TargetAccessRequired property, call the property accessor methods on PropertyDefinitionObject.

See Also



TargetClass

Specifies the DocumentClassDefinition object that defines the target document class for this XMLPropertyMappingScript object. The target class indicates the specific document properties that will be mapped to by the property-mapping script.

See Also



TargetObjectStore

Specifies the object store to which documents from this IBM® Content Manager OnDemand (CMOD) application group are federated or to which instances of this external class description can be replicated.

See Also



TempDBContentLifetime

The number of seconds temporary content can exist in the database before being considered abandoned.

See Also



TempDirectoryPath

Assigns the directory to be used for storing temporary indexing files. The directory must be available to both the Content Engine and Verity servers, and can be a directory share, a local mount point, a UNC, or a local path.

Note: If this is a local path, the Verity server must be located on the same machine as the Content Engine server, and there cannot be multiple Content Engine servers.

See Also



TempFileLifetime

The number of seconds that temporary files must exist in the inbound directory before they will be considered abandoned. Abandoned files get deleted as part of a periodic cleanup; for more information, see the AbandonedContentCleanupInterval property.

See Also



TemplatePermissionDescriptions

A list of descriptions of permissions applicable to the template. This property represents the set of AccessPermissionDescription objects to be used when creating a security template.

See Also



TemplatePermissions

Contains the set of discretionary AccessPermission objects to be used when creating a security template.

See Also



TemplateType

Contains the Verity style file alias name that identifies the Verity style files used for indexing data. The style files control the format of indexed data (using exception word lists, for example).

See Also



This

The current object. The primary purpose of this property is to enable the expression of relationships among objects in a Content Engine query and to select candidate objects in the query results.

See Also



ThreadCount

The number of threads to use for background processing of index requests. This value should be set higher for machines with more CPUs, or for configurations that distribute processing across multiple Verity index servers.

See Also



TimeAllSubmitted

Indicates the time when all requests have been submitted for this indexing job. This value is null if all index requests have not yet been submitted. Note that this property does not indicate completion of the requests contained in the indexing job (see the JobStatus property for this information).

See Also



TimeLastProcessed

Indicates the time when the last activity occurred on this indexing job.

See Also



TimeOutSeconds

Specifies the maximum time in seconds that the Content Engine will wait when retrieving content from an Image Services server.

See Also



Title

Specifies the title of this style template.

See Also



ToVersions

Specifies a list of IDs that identify the add-on versions logically produced as a result of applying this UpgradeAddOn object. The list must contain one or more IDs (and will usually contain only one).

See Also



TopFolders

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

See Also



TraceLoggingEnabled

Indicates whether trace logging is currently enabled for all configured subsystems.

See Also



TransformationOptions

Specifies a binary-valued, publishing transformation handler-specific description of the transformation to be done for this style template. This could be an XML-based description or the ID of another document that contains a more detailed template. For publishing to an external location, the publishing transformation handler implementers could also have chosen to put a URL as part of this property's value.

The publish style templates associated with the PDF publishing event handler can optionally specify PDF security and watermark settings (stored as XML in the TransformationOptions property). The publish style templates associated with the HTML publishing event handler do not specify any settings in the TransformationOptions property.

See Also



U

URIValue

The URI address for the document designated as the child in a component relationship. This property applies when the ComponentRelationshipType property setting is URICR. For other component relationship types, you designate the child component by setting the ChildComponent property. If the ComponentRelationshipType property is set to anything other than URICR, the value of the URIValue property is null. Any String value can be entered into this property; the value does not have to be a valid URI address.

See Also



UsedInClasses

Specifies a ClassDefinitionSet object representing the classes that have a property constructed from this property template.

See Also



UserBaseDN

Specifies the base Distinguished Name (DN) for searching for users in the directory server.

See Also



UserDisplayNameAttribute

Specifies the directory server attribute to be used as the display name for a user. The default property value is dependent on the directory server type and is specified by the authentication provider's configuration.

See Also



UserDomain

The LDAP domain to which the user specified in UserName belongs. The values of the UserDomain, UserName, and UserPassword properties are used to login to Verity for indexing and search operations.

See Also



UserGroup

The group to which the Content Engine user account name specified in UserName belongs. Only members of this group are allowed to add to, modify, or read the Verity collection.

See Also



UserName

The name of a user account assigned to Content Engine servers for access to Verity collections. The user name must be a member of the group specified in UserGroup. The values of the UserDomain, UserName, and UserPassword properties are used by Content Engine servers to log in to Verity for indexing and search operations.

See Also



UserNameAttribute

Defines the directory server attribute to be used as the short name for a user. The default value of this property is unique to the directory service provider as follows:

See Also



UserPassword

The password assigned to the Content Engine user account name specified in UserName. The values of the UserDomain, UserName, and UserPassword properties are used by Content Engine servers to log in to Verity for indexing and search operations.

This value is encrypted (a byte array).

See Also



UserSearchFilter

Specifies the search filter for querying a user or users. The filter must be in the following format: "(&(objectClass=user_defined_class)(an_attribute={0}))", where user_defined_class is the object class you want (for example, user or person) and an_attribute is the LDAP server-specific attribute (for example, samAccountName, cn, or uid).

The default value of this property is unique to the directory service provider, as follows:

See Also



UserString

A string used to identify a subscription, with no built-in behavior.

See Also



UserTokenCacheEntryTTL

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

For more information about this cache, see Security Caching.

See Also



UserTokenCacheMaxEntries

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

For more information about this cache, see Security Caching.

See Also



UserUniqueIDAttribute

This property is not supported.

See Also



UserUniqueIDAttributeIsBinary

This property is not supported.

See Also



Users

A collection of User objects belonging to a given realm.

See Also



UsesLongColumn

Specifies whether this string-valued property is stored in a database column as a short string (false) or as a long string (true).

Long-string table columns store their values separately from the rest of the table and therefore bypass table row-size limitations. To avoid a table's row-size limitation being exceeded, you should use a long-string column to store a large string-valued property if the database table in which it is stored has many custom properties. Because the actual text data for a long-string column is stored separately from the rest of the database row data (requiring an additional read operation to retrieve the data) you might experience a slight decrease in performance. However you might also potentially experience a system performance gain, because the overall row size for each object is reduced when long-string columns are used, therefore decreasing fetch and storage times.

Note that, unlike short-string columns, long-string columns cannot be specified in a database index.

For database-specific information about short-string and long-string table columns, table columns, see Database Engine Differences.

See Also



V

VWVersion

A unique identifier for a compiled (transferred) workflow definition. The Process Engine assigns this property's value after a workflow definition is transferred to the Process Engine server (either via the Process Designer application or the filenet.vw.api.VWSession interface's transfer method).

See Also



VendorName

Specifies a vendor name.

See Also



VerityBrokerNames

The name of the Verity broker to use for the current VirtualServer instance. If unspecified, a broker of the name <server_name>_Broker is used.

See Also



VerityBrokers

The names of all Verity brokers associated with the Verity administration server specified in VerityMasterAdminServerHostname. This is the list of brokers returned from Verity.

See Also



VerityCollections

The set of VerityCollection objects associated with this index area. Each Verity collection is a member of only one index area.

See Also



VerityDomainConfiguration

The Verity configuration attributes that affect the entire domain, and may not be changed on a server by server instance.

See Also



VerityIndexServers

The names of all Verity index servers associated with the Verity administration server specified in the VerityMasterAdminServerHostname property. This list of index servers is returned by Verity.

See Also



VerityMasterAdminServerHostname

The name of the Verity administration server used to create Verity collections. This master administration server will be contacted by Content Engine servers for all requests to create a Verity collection.

See Also



VerityMasterAdminServerPort

The port assigned to the master Verity administration server specified in VerityMasterAdminServerHostname.

See Also



VeritySearchServers

The names of all Verity (search) servers associated with the Verity administration server specified in the VerityMasterAdminServerHostname property. This list of index servers is returned by Verity.

See Also



VersionBindType

The setting for selecting the version bind rule in effect; this rule partly determines the child component document version bound with the parent component for component relationship types of DYNAMIC_CR and DYNAMIC_LABEL_CR. For all other component relationship types the value of this property is null. (For information on document binding specifics, see ComponentRelationshipType Property.) The VersionBindType class has constants defined for the bind type settings.

Valid settings are:

See Also



VersionSeries

Specifies a VersionSeries object that contains all of the document versions associated with this document or DynamicReferentialContainmentRelationship object.

See Also



VersionSeriesId

For a PublishCompleteEvent object, the ID of the version series of the publication document. For other versioning-related events, the ID of the version series for the source object. Note that this property will have a valid value only when the event's source object is an instance of Document or its subclass.

See Also



VersionStatus

Specifies a VersionStatus constant that indicates the current version status of this document version.

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

Name Value Description
IN_PROCESS 2 Indicates an in-process document version. An in-process version is a version that has been checked in and is the latest minor version. Note that only one version at a time in a given version series can be in the IN_PROCESS state. When a reservation version is checked in as a minor version and becomes the new in-process version, the previous in-process version becomes a superseded version.
RELEASED 1 Indicates a released document version. A released version is a version that has been checked in and is the latest major version. Note that only one version at a time in a given version series can be in the RELEASED state.
RESERVATION 3 Indicates a reservation document version. A reservation version is a version that has been checked out.
SUPERSEDED 4 Indicates a superseded document version. A superseded version is a major or minor version that has been replaced by a later version.

See Also



Versions

Specifies a VersionableSet object that contains all of the document versions associated with this document or version series.

See Also



VirtualServer

A logical entity for managing a group of server instances.

See Also



VirtualServers

Represents a collection of VirtualServer objects for a given site.

See Also



W

WSITraceFlags

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

See Also



WorkflowDefinition

A WorkflowDefinition object representing the workflow definition associated with a workflow subscription.

See Also



WorkflowDefinitions

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

See Also



WorkflowSourceSubscriptions

A SubscriptionSet collection containing the workflow subscription (InstanceWorkflowSubscription and/or ClassWorkflowSubscription) objects associated with a workflow definition.

See Also



WorkflowSubscriptions

The InstanceWorkflowSubscriptionSet object containing the InstanceWorkflowSubscription objects whose target is this object.

See Also



X

XMLDocumentType

Specifies the type of source XML document to which this XMLPropertyMappingScript object applies. The value of this property can be one of the following:

See Also



XMLPropertyMappingScripts

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

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

See Also