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.
This property works in conjunction with the TempFileLifetime property to determine which files get deleted as part of a periodic cleanup.
This property works in conjunction with the TempDBContentLifetime property to determine which temporary content gets deleted as part of a periodic cleanup.
AccessPermission
, the access rights are granted on a given object to the grantee specified on the access permission.AccessPermissionDescription
, the access rights are those that may be granted on a given object.AccessPermission
object.
Each FileNet P8 Site
instance can be mapped to no specific DNS site or exactly one DNS site.
If more than one site is configured for the FileNet P8 domain, and these sites are in different geographical locations,
LDAP communication between the application server and the directory server might go across a WAN
and performance might suffer.
To alleviate this, you can set this property, which causes the API to search for all domain controllers for the
given domain under that site. For example, you could set the value of this property to "Chicago".
All domain controllers for the given domain under "CN=Chicago,CN=Sites,CN=Configuration,DC=..."
are tested by attempting a connection. The first running domain controller is selected.
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.
AddOnInstallationRecord
objects corresponding to this object store.
ReplicationDirection
constant that specifies the direction in which mapping
applies for this class or property alias: inbound, outbound, or both.
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).
Realm
objects for the EntireNetwork
object.
If the value of this property is false, the Active Directory security provider parses login user names (principal names) to determine if the name is in UPN format, meaning that it contains an @ character followed by at least one dot character (for example, jsmith@mydomain.com). If the principal name is in UPN format, it is assumed to take the form name@domain, where name is the user name and domain is the name of an Active Directory domain configured in Administration Console for Content Platform Engine. This special handling can be useful in some large Active Directory forest and domain setups, but prevents email addresses and certain UPNs from being used as the user short name.
If the value of this property is true, the Active Directory security provider does not parse the principal name, which allows email addresses and
UPNs to be used as the user short name. Setting this property to true implies that ReturnNameAsDN
is also set to true.
This property has a global effect. Therefore, it must be set the same (either all true or all false) for all Active Directory configurations defined for a Content Engine. If this property is not set the same for all configurations, the property value is implicitly false.
This property is settable only on the CmRetentionUpdateJob
class definition.
The MODIFY_RETENTION
permission is required on the object store
to change the property.
VirtualServer
or ServerInstance
.
In IBM Content Foundation, Case Analyzer is not supported, and this property is ignored.
AnnotatedContentElement values
. It is not a required property.
Because the positional index of a given content element within a document's ContentElementList
collection is subject to change,
it is recommended that you populate this property with the value of the content element's ElementSequenceNumber
property rather than its positional index. If you instead choose to use a positional index, it is up to your application to ensure that it
accurately reflects the correct index of the content element to which the annotation applies.
For example, if the AnnotatedContentElement property specifies the
positional index of the third content element of a document with five content elements, and the second content element is then removed,
the property will consequently reference the wrong content element.
IndependentObject
object of type Document, Folder, or CustomObject to which this annotation has been applied.
AnnotationSet
object that contains the annotations associated with this object.
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:
Sends trace logging data to the default console (such as System.out).
Sends trace logging data to the location specified in the OutputLocation
property.
A subclass of FileAppender. Backs up (rolls over) the trace logs located in the directory referenced by the
OutputLocation
property on a scheduled basis. The DatePattern is "yyyy-MM-dd", which
initiates the backup operation daily at midnight.
A subclass of FileAppender. The default appender used if none is specified. Backs up the trace logs located in
the directory referenced by the OutputLocation
property when the files exceed the maximum size.
The default maximum trace log file size is 100MB, and the default backup index file size is 5MB. You can override these default values using the log4j command line properties "MaxRollingFileSize" and "MaxRollingFileBackups".
For more information, see org.apache.log4j.FileAppender.
VersioningSecurityTemplate
, the state can be one of the following:
For an ApplicationSecurityTemplate
, the state is defined by your application.
PropertyTemplate
that represents an individual property to be audited in a class.
An audited source property in a class is mapped to an event property in an audit record of the Event table.
By default, AuditAs is set to null
.
Custom properties can be audited by setting PropertyDefinition.AuditAs
to an existing PropertyTemplate
,
which typically is the same object from which the PropertyDefinition
was created.
However, system properties do not have pre-existing property templates, so you must create a new property template for a system property
that you want to audit. For code examples, see Configuring Property Auditing.
AuditAs is settable on a PropertyDefinition
as long as that PropertyDefinition
does not already inherit an AuditAs value.
Once set, its value is automatically inherited as read-only in subclasses.
If the PropertyDefinition
referenced by an AuditAs property is deleted, then that AuditAs property becomes settable on all immediate subclasses.
For example, if root class A has a property P that is audited, and also has immediate subclasses A1 and A2,
then P on A1 and P on A2 (referred to as P1 and P2) are inherited, with the same AuditAs value as set on A.P.
If A.P is deleted, P1 and P2 get promoted to non-inherited properties on A1 and A2, respectively.
As non-inherited properties, P1 and P2 now have AuditAs values that can be modified to point to a different property, independently of each other.
On PropertyDescription
, AuditAs is read only.
ObjectStore
object.
Each CmAuditDispositionPolicy object
in the enumeration defines the criteria in which audit records are identified for disposition (deletion).
AuditDispositionBatchSize
.
CmTimeslot
objects, with each object
specifying a weekday, start time, and duration for audit disposition to run.
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.
ObjectStore
object.
ObjectStore
object.
Each CmAuditProcessingBookmark object
in the enumeration represents a leave-off point in the audit log (Event table) by an audit processing client.
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.
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).
EventSet
collection of the Event
objects containing the audited events that have occurred for the
object.
CmTextSearchIndex
object.
The server computes the new retention date by adding the value of the RetentionDurationUpdate property, expressed in the units specified by the RetentionPeriodUnits property, to the value of the date property specified by the BaseDatePropertyName property.
If the AllowRetentionReduction property is set to true, you can use the BaseDatePropertyName property to reduce retention. Set the BaseDatePropertyName property to a date property other than the CmRetentionDate property. Then set the RetentionDurationUpdate and RetenionPeriodUnits properties so that the new retention date computes to a value that is less than the current CmRetentionDate property value of the retainable objects.
The maximum number of batches that are selected by the import agent dispatcher from the database in a single database round trip.
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).
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:
VerityDomainConfiguration
object must exist.
Any valid locale name supported by Verity can be used. This value must be set before any
VerityIndexArea
objects are created, and may not be modified while any VerityIndexArea
objects exist.
If the locale is "uni" the default language code can optionally be appended to this name (such as "uni/fr" for
French). When a language code is appended, queries use the specified language as the default language for word stemming and other
language-specific features.
Specifying a language code here applies only to the default language used. It does not preclude the use of additional languages for the object store. Multiple languages can be indexed into Verity collections in the same object store.
true
to extract text from documents using Content
Engine and false
to extract text using the text search
engine. The text search engine builds the CBR indexes using the
extracted text in both cases.
Set the property value to true
only if the Content
Engine text extraction capabilities have been installed. If those capabilities
have not be installed, Content Engine logs the error "CBRPreFilter is not
deployed" to the FileNet P8 log file when it attempts to filter the text for a
document.
Content Engine creates a separate subprocess to filter the text for each document. On occasion, a malformed document might cause a subprocess to enter an unstable state such that it can never complete its text extraction task. You can configure how long Content Engine allows a subprocess to run by setting the CBRPreFilterInitialTimeout JVM option. When a timeout occurs, Content Engine terminates the subprocess and can retry the filter operation by creating another subprocess. Use the CBRPreFilterMaxRetryCount JVM option to specify the maximum number of retry subprocesses. The descriptions for these JVM options follow:
subprocess n timeout interval = 2(n-1) * option value
where n is one for the first subprocess, two for the second (retry) subprocess, and so on. For example, if the value for this option is 60, the timeout period for the first subprocess is 1 minute (60 seconds); for the second, 2 minutes; for the third, 4 minutes; and so on. Content Engine considers no timeout interval to be in effect when the the value for this option is zero.
This property applies only if the CBRQueryOptimization property
is set to DYNAMIC_SWITCHING
, and if a query does not include a SQL optimization option.
If this property is not set, the CBR search always executes first. If this propety is set to zero,
the DB search always executes first.
For more information, see CBR Query Optimization.
A full-text search on indexed content is a content-based retrieval (CBR) search. A relational search on
properties is a database (DB) search. If the property is set to NONE
(0 or null), the Content Engine
always performs the CBR search first and the DB search second.
If the property is set to DYNAMIC_SWITCHING
(1), then the Content Engine dynamically determines
whether to issue the CBR search first or the DB search first, optimizing performance for these types of searches.
In dynamic switching mode, the Content Engine switches from CBR first to DB first based on an estimated number
of CBR hits. The estimate is compared to a threshold value, set in the
CBRQueryDynamicThreshold property.
If you set this property to DYNAMIC_SWITCHING
, then you must also set the CBRQueryDynamicThreshold property.
In dynamic switching mode, CBR-first behavior can be forced by CBR searches that request rank order. To maintain dynamic switching behavior, you must enable the CBRQueryRankOverride property.
You can also set this property in combination with other object store properties to force DB-first search behavior. For information about configuring the server for a particular behavior, the tradeoffs involved, and the SQL query options to override this property, see CBR Query Optimization.
DISABLED
(0 or null).
This setting applies to CBR searches that combine both a full text query and a relational search on a database (DB),
and when the CBRQueryOptimization property is set to DYNAMIC_SWITCHING
.
In dynamic switching mode and for a search requesting rank order, the server can only calculate results in rank order when the search is performed content first (CBR-first search). It is not possible for the server to perform the search database first (DB-first search) with rank order calculated.
This setting forces CBR-first only searches for combined queries that request rank order.
The server will not perform DB-first searches if rank order is requested. If you want results to always be ordered by rank,
set this property to DISABLED
.
ENABLED
(1). This setting applies to CBR searches that combine both a full text query and a relational search on a database (DB),
and when the CBRQueryOptimization property is set to DYNAMIC_SWITCHING
.
For optimized execution of combined searches that request rank order, set this property to ENABLED
.
The server will dynamically switch between CBR first and DB first, and will return CBR-first searches in rank order.
The server will suppress the request for rank order if dynamic switching chooses a DB-first search.
REQUIRED
(2). This setting suppresses a request for rank order for all CBR searches, with or without dynamic switching enabled,
including CBR-first searches.
With dynamic switching and a setting of REQUIRED
, the server will dynamically switch between CBR first and DB first,
and it will suppress the request for rank order for both DB-first and CBR-first searches.
Removing all rank ordering can help performance, especially for searches running against multiple collections.
For more information, see CBR Query Optimization.
ObjectStore.get_CBRSearchType
method to retrieve the value.
If CBR is not enabled for the object store, the returned value is
NONE
. Otherwise, the value identifies the currently configured search engine.
(See the related constants in com.filenet.api.constants.CBRSearchType.)
Specifies the maximum size of text to be retained in the text index from which to generate a summary.
Specifies the maximum size of summary text to be returned in a text search result.
Defines the type of summary text to be available in text search results.
For more information on CFS interaction with an external IBM Content Integrator repository, see the
IICEFixedContentDevice
interface.
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.
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.
Valid settings are:
OPEN
(default setting): Enables the cache area for active use.CLOSED
: Disables the cache area for active use.CLEARING
: Disables the cache area for active use, deletes all content
from the cache, initializes the values for all cache statistical properties, and
automatically resets the cache status to the previous setting (OPEN
or CLOSED
). Once
started, this cache clearing operation always completes; you cannot stop the operation
or manually change the cache status from CLEARING
to any other setting. In order for
the clearing operation to be performed and for the cache status not to remain set to
CLEARING
indefinitely, at least one server must be associated with the same site as
that of the content cache. For information on associating a content cache with a site,
see the ContentCacheConfiguration interface.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.
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.
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.
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:
PropertyDescriptionObject
and PropertyDefinitionObject
objects only, this
property can have any Cardinality
constant value: SINGLE
, ENUM
, or LIST
.PropertyDescription
and PropertyDefinition
object types, this
property must have a value of SINGLE
or LIST
.
For PropertyTemplate
object types, this property is settable on create:
PropertyTemplateObject
objects only, this property must have a value of SINGLE
or ENUM
. You can only create a custom object-valued property that has single or enumeration cardinality;
list cardinality is allowed for system object-valued properties only.PropertyTemplate
object types, this property must have a value of SINGLE
or LIST
.The Cardinality property can have one of the values in the following table.
Name | Value | Description |
---|---|---|
ENUM |
1 | Specifies a property with enumeration cardinality. A property with enumeration cardinality is an object-valued property that returns a set collection. A set collection is a read-only collection of unique, unordered, independent objects that must be traversed sequentially. You can iterate through the items of a set collection one page of elements at a time from the server to your client application. However, if the collection changes on the server while you are iterating through it, the number, order, and values of the items in your client copy can change, even if you maintain the same reference to it. A set collection cannot hold any items other than independent objects. By contrast, a list collection can hold items of any data type, with the exception of independent objects. |
LIST |
2 | Specifies a property with list cardinality. A property with list cardinality returns a list collection. A list collection is a collection of ordered items that can either be modifiable (allowing items to be inserted, replaced, or deleted) or read-only. These items need not be unique and can be traversed in any order. When you access a list collection from the server, a complete copy of it is created on your client application, which you can iterate through one element at a time. The items in a list collection must all be of the same data type and must match the data type of the property that returns it. If the property returning a list collection is an object-valued property, all of the objects in the list collection must be dependent objects. A list collection can hold items of any data type (provided each item is of the same data type. However, if a list collection holds objects, they must all be dependent objects; only a set collection can hold independent objects. You cannot create a custom property with list cardinality. |
SINGLE |
0 | Specifies a property with single cardinality. A property with single cardinality returns a single value of the data type that the property can hold. |
ObjectStore
object.
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.
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.
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.
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
.
Choice
object that holds an integer data type in a choice list.
ChoiceList
object that represents the discrete set of possible values
that this property can hold.
ChoiceListSet
object containing the set of ChoiceList
objects defined in this object store.
Choice
object that holds a string data type in a choice list.
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. |
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.
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.
ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
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.
For ExternalClassDescription
objects only, this string is immutable and is unique within
the repository in which the external class description belongs.
DocClassificationStatus
constant that indicates the auto-classification status for this document.
The ClassificationStatus property is used to provide client applications a means of discovering whether a particular
document is subject to auto-classification, and if so, whether or not the operation was successful.
This property can hold one of the following values:
CLASSIFICATION_COMPLETE
: Indicates that document auto-classification has completed successfully.CLASSIFICATION_FAILED
: Indicates that document auto-classification has failed.CLASSIFICATION_PENDING
: Indicates that a request for document auto-classification is pending. This value is
set automatically by the server when you check in a document and set the checkin
method's
autoClassify
parameter to AUTO_CLASSIFY
.NOT_CLASSIFIED
: Indicates that document auto-classification has not been requested. This value is set
automatically by the server when you check in a document and set the checkin
method's autoClassify
parameter to DO_NOT_AUTO_CLASSIFY
.If you enable content compression, you can modify default operation settings with the CmCompressionThresholdPercent and CompressionBlockSize properties.
Some data formats, such as JPEG and ZIP, do not compress well, and the server compression overhead might not be worth the marginal savings of storage space for such formats. This property allows you to define the threshold at which data will not be compressed. You can also define the block size of the content stream to be compressed, as set in the CompressionBlockSize property.
This property requires that content compression be turned on, as set in the CmCompressionEnabled property. For administrator-related information, see Content compression.
If false, the predecessor task in the relationship is required, meaning that the predecessor task must be completed before the successor task is allowed to advance. If true, the predecessor task in the relationship is not required, but rather serves as an alternate in a group of multiple alternates associated with the same successor task. If any of the alternate predecessor tasks are completed, the successor task is allowed to advance, subject to any required predecessors having also completed.
DeviceRetentionMode
constant that specifies the retention mode of this fixed
storage area relative to a fixed content device. Both retention modes apply only to
checked-in documents that have their content stored on a fixed content device.
This property can have one of the following values:
ALIGNED
: Specifies an alignment relative to a fixed content device. Documents
checked in on a fixed storage area in aligned mode have retention enforced by both the Content Engine
server and the fixed content device. In this mode, the fixed content device must support the retention period
specified by the value of the CmRetentionDate property of the document, or else the operation fails.
If the source location of the content data of a document is on a fixed content device that is under aligned mode,
the content data can only be deleted or moved if the retention period of the document has expired. NOT_ALIGNED
: Specifies no alignment relative to a fixed content device.
In this mode, retention is enforced by the Content Engine server only.CmHoldRelationship
objects associated with this object.
IndexingFailureCode
constants that identify the types of indexing failures that have occurred
as a result of an index request for a CBR-enabled object. If there are no indexing failures, the CmIndexingFailureCode
property returns a value of zero.
If you set the value of the IndexingFailureRecordingLevel property of an ObjectStore
object to PROPAGATE_TO_SOURCE
,
the error information is propagated to the CmIndexingFailureCode property of all CBR-enabled objects.
true
, the object
is the original object explicitly marked for deletion by a user, or the object is referenced by the
original object through an object-valued property (OVP), and, therefore, was marked for
deletion by the server.
Objects marked for deletion are represented by a CmRecoveryItem
object, through which the objects can be either recovered or purged (removed from the
object store database).
null
,
this object is not held under retention and there are no restrictions on when it can be deleted.
When you create an object, the Content Engine server automatically sets the CmRetentionDate property to the default retention date and time. The Content Engine server calculates the default retention date and time by adding the retention period (DefaultRetentionPeriod property of the object's class definition) expressed in the selected duration units (RetentionPeriodUnits property of the object's class definition) to the date and time when the object was created. Alternatively, you can override the default value by setting the CmRetentionDate property of the object to a specific date and time. Once an object has been created, you cannot change the value of its CmRetentionDate property to a smaller value; that is, the retention period of the object cannot be shortened.
An object that has related objects under retention cannot be deleted until all of its related objects have been deleted. For example, a document with annotations cannot be deleted until all of its annotations have been deleted. The retention dates of a document and its annotations are independent of each other.
When a document is checked out, its CmRetentionDate property value is not applied to the resulting reservation object. If you set the CmRetentionDate property of the reservation object, the property value is applied to the new document version when you check in the reservation object. Note that setting the CmRetentionDate property of the reservation object does not prevent the reservation object from being deleted. If you do not set the CmRetentionDate property of the reservation object when you check it in, the CmRetentionDate property of the new document version is automatically set to the default retention date and time.
The CmRetentionDate property can be set to a specific date and time, or it can be set to one of the following RetentionConstants
constants:
INDEFINITE
: Indefinite retention. Specifies that the object can be deleted only if the CmRetentionDate
property is changed to an expiration date and time, and that date and time is in the past. This property can be set
to INDEFINITE
only if it has a value of null
. If this property has been set to INDEFINITE
,
it cannot be set to null
; it can only be set to a date and time value or to PERMANENT
.PERMANENT
: Permanent retention. Specifies that the object can never be deleted. To set the CmRetentionDate property value on an object, you must have the following permissions:
StoredSearch
object.
When an open index areas becomes full, the Content Engine server chooses the standby index area with the highest priority and sets it to open. If two or more index areas exist with the same priority, one of these standby index areas is chosen randomly by the server.
You can control this feature by setting the JVM parameter
com.filenet.engine.cbr.LegacyStandbyActivationPolicy on your application
server. By default, this JVM parameter is
Action
-based object is invoked.
A CodeModule
object represents a user-implemented
Java action handler that is checked into the Content Engine.
ColumnDefinitionList
collection object containing the ColumnDefinition objects that describe the columns in the
table.
Valid settings are:
CASCADE_DELETE
: Causes the child component document to be automatically
deleted when the parent component document is deleted. Document deletion succeeds if you have
delete rights (AccessRight.DELETE
) for all child components involved in the cascade delete.
Otherwise no component (including the parent component) can be deleted. For example, if two component
relationship objects designate D1 as the parent document for D2, and D2 as the parent document for D3,
and define a cascade delete relationship between D1 and D2 and also between D2 and D3, you can
delete D1 only if you have delete rights for all three documents.NO_CASCADE_DELETE
(default setting): Causes no special action to occur when
the parent component document is deleted.Valid settings are:
ALLOW_BOTH_DELETE
(default setting): Allows the deletion of both the parent and child component documents.PREVENT_BOTH_DELETE
: Prevents the deletion of both the parent and child component documents.PREVENT_PARENT_DELETE
: Prevents the deletion of the parent component document.PREVENT_CHILD_DELETE
: Prevents the deletion of the child component document if the
parent component document exists. This setting also prevents the deletion of a parent component document if the
ComponentCascadeDelete property for this ComponentRelationship
object is set to
CASCADE_DELETE
(which deletes the child when the parent is deleted).Valid settings are:
STATIC_CR
(default setting): Binds the parent component version to the explicitly
specified child component version. Set these required properties to create a ComponentRelationship
object with this setting: ParentComponent and ChildComponent.DYNAMIC_CR
: Binds the parent component version to the most recent child component
version that satisfies the version bind rule. For information on the version bind rule, see
VersionBindType Property.
This setting expects an eligible-for-binding child component version to exist; for more information on this requirement,
see ChildComponent Property.
Set these required properties to create a ComponentRelationship
object with this setting:
ParentComponent, ChildComponent, and VersionBindType.DYNAMIC_LABEL_CR
: Binds the parent component version to the most recent child component
version satisfying the version bind rule that has a ComponentBindingLabel property value matching the LabelBindValue
property value. No binding occurs if no such child document version exists. The value comparison considers the two
properties to be matching when they have the same value, or when LabelBindValue has a null
value
and ComponentBindingLabel has a non-null
value. For information on the version bind rule,
see VersionBindType Property.
Set these required properties to create a ComponentRelationship
object with this setting:
ParentComponent, ChildComponent, VersionBindType, and LabelBindValue.URICR
: Creates a component relationship between the parent component document and the
URI document specified by the URIValue property. The URI can be for a P8 Content Engine document, and any
other "document" a URI can refer to. Set these required properties to create a ComponentRelationship
object with this setting: ParentComponent and URIValue.When you modify the ComponentRelationshipType property from one setting to another, be aware that the previously set values for some properties might be lost:
URICR
setting; the property value is null
for all other settings.STATIC_CR
, DYNAMIC_CR
, and
DYNAMIC_LABEL_CR
settings; the property value is null
for the URICR
setting.DYNAMIC_CR
and DYNAMIC_LABEL_CR
settings;
the property value is null
for all other settings.DYNAMIC_LABEL_CR
setting; the property value is null
for all other settings.For an overview of document binding, see the ComponentRelationship class.
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.
Valid settings are:
COMPOUND_DOCUMENT
: Designates the document as the parent component in a
compound document. Initially, this parent document has no child components. A document must be
designated as a compound document to become a parent component for a ComponentRelationship
object.STANDARD_DOCUMENT
(default setting - 4.0.x release): Designates the document
as a standard document. This setting prevents the document from being a parent component within a
compound document. A document cannot be designated as a standard document when referenced as
a parent component by a ComponentRelationship
object.null
(default setting - 3.5.x upgraded to 4.0.x): Designates the document as a
standard document. By default, pre-existing documents in an object store upgraded to 4.0.x return a null
value instead of STANDARD_DOCUMENT
. Note that, although a null
value can be returned, you cannot set this property to null
.This property requires that content compression be turned on, as set in the CmCompressionEnabled property. For administrator-related information, see Content compression.
GenericFixedContentDevice
object. There is
no fixed format for this property (other than, it must be a string that the custom implementation of
the fixed content provider can understand and parse).
This property is not currently supported.
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.
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.
DocumentSet
collection object containing the Document
objects contained within this folder.
ReferentialContainmentRelationshipSet
collection object containing the
ReferentialContainmentRelationship
objects contained within this folder.
ReferentialContainmentRelationshipSet
collection object containing the
ReferentialContainmentRelationship
objects that identify the containers of this 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:
Head
object has a MimeType property (in other words, the Head
object is a Document
),
and if both the
Name and MimeType properties of the Head
object are present and not zero length, then the default value is
Name.FileExtension. Content Engine maps the MIME type of the Head
object to a file extension based on
the mimetypes.properties
file to determine FileExtension. If an apparent file extension is already present in the value of the Name property, then the default
is the Name value of the Head
object (no FileExtension is appended). If the value of the MimeType property
does not map to any file extension, then no FileExtension is appended. In all cases, invalid characters (see list below) are
removed from the Name value, and the Name value is truncated to 255 characters.Head
object. Invalid characters are removed from the Name value, and the Name value is truncated to 255 characters.Head
object is used.The following characters are not allowed:
\ / : * ? " < > |
For an Event
object generated from the FileEvent
and UnfileEvent
classes, the value of this property is the name of the
Containable
object that was added or removed, respectively.
In the following scenarios, the server looks for naming collisions and makes the containment name unique:
AutoUniqueName.AUTO_UNIQUE
is set when the object is filed.
This setting should be used with caution, as described in
Class AutoUniqueName.If a naming collision is detected when AutoUniqueName.AUTO_UNIQUE
is set, or when an object that's marked for deletion object
is restored, the server resolves the conflict by appending a unique suffix to the the containment name, as follows:
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:
doc.refresh(new String[] {PropertyNames.DATE_CONTENT_LAST_ACCESSED, PropertyNames.ID, "Content", PropertyNames.CONTENT_ELEMENTS});
DateContentLastAccessed
property is updated during the refresh.Document.accessContentStream
is called to
retrieve the content. For example:
doc.refresh(new String[] {PropertyNames.DATE_CONTENT_LAST_ACCESSED, PropertyNames.ID, PropertyNames.CONTENT_ELEMENTS});
DateContentLastAccessed
property is updated
during the content access operation (via the accessContentStream
method).Note that even if the content is larger than the specified chunk size (default or user-specified) and
multiple trips to the database or cache are performed, the DateContentLastAccessed
property
is set to the time when the content is first accessed.
ContentCacheArea
objects associated with the FileNet P8 domain.
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.
StorageArea
object,
this property reflects the compressed size of the content.
For the ContentCacheArea
object, this property returns null
when the server cannot physically access the cache storage area and the CacheStatus
property setting is Closed
. Also, this statistic can become inaccurate;
for more information, see the ContentElementCount property.
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).
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.
StringList
object containing the MIME type of each content element
associated with this document or annotation at the time it was last saved.
ContentReference
object.
This property is maintained for backward compatibility and is automatically populated by the server with the same value as the document’s CmRetentionDate property.
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.
When performing a full-text (CBR) search, avoid referencing the ContentSummary column. The retrieval of this text column can slow the execution of the search.
When the value for this property is null, the server uses the FileNet working directory as the directory root for temporary content.
You can set the ContentType property of a specific content element
when you create it and attach it to a document version. The ContentType property requires a value.
If you do not provide a value for the ContentType property of a ContentReference
object,
an error occurs. By contrast, if you do not provide a value for the ContentType property of a
ContentTransfer
object, the Content Platform Engine attempts to discover the MIME type of the content data,
and automatically sets the property to an estimated MIME type value.
However, it is not always possible for the Content Platform Engine to make a correct determination of the content data
that the ContentTransfer
object holds.
Therefore, IBM recommends that you always set this property to the correct MIME type value when you
add the content element. At a minimum, if you do not specify the MIME type value of the ContentType
property, ensure that the path specified by the RetrievalName property of the ContentTransfer
object contains the correct filename extension for the type of content data.
Although the Content Platform Engine does not enforce the format of this property's value, a MIME format string consists of a content type, a content subtype, and an optional parameter in the following format: "content type/subtype[;parameter]", for example, "text/html". Interpretation of the value is up to retrieving applications.
MIME defines the following content types:
The following MIME types are specific to FileNet:
ContentReference
content element.Containable
object.
Each CmTask
object in the enumeration represents a single piece of work in a business process.
A CmTask
object with a Coordinator
property set to this Containable
object is added to the enumeration value of this property.
Containable
object that is acting as the coordinator for this and other related tasks.
To return an enumeration of all related tasks coordinated by the object, call
Containable.get_CoordinatedTasks
.
For a PropertyDefinition
object, a value indicating whether the value of the property defined by this
property definition should be copied, during checkout, from the source document to the newly created reservation object.
For a PropertyDescription
object, CopyToReservation is read only.
For a ComponentRelationship
object, a value indicating whether this object gets copied, during
checkout of the parent component source document, for the newly created reservation object. The reservation object
becomes the parent component for the new copy of this ComponentRelationship
object. Consequently,
both the reservation object and the source document have an equivalent component relationship with the same child document.
Note that the reservation object behaves like any other document with respect to compound document properties and relationships.
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.
DocumentState
object representing the
current lifecycle state of this document.
-Xmx512m
.
DITARenditionEngineConnection
object used by this publishing configuration.
DITARenditionEngineConnectionSet
object that lists the
DITA Rendition Engine connections for this domain.
TypeID
constant, which indicates the data type of the value that an object can hold.
For PropertyDescription
, PropertyDefinition
, and PropertyTemplate
objects,
this property is read-only and specifies the data type of the value that an object property can hold.
Because the value of the DataType property is automatically set by the Content Engine server to correspond
to the specific object type of the PropertyDescription
, PropertyDefinition
,
or PropertyTemplate
object, you do not need to set it when you are creating a property template or
property definition. For example, in a PropertyDescriptionBinary
, PropertyDefinitionBinary
,
or PropertyTemplateBinary
object, the server automatically sets the DataType property
to a value of BINARY
.
For ChoiceList
objects, this property is settable on create and must be a LONG
or
STRING
constant value. This property determines whether a choice list is an integer-type choice list, which holds
integer-type choice items or a string-type choice list, which holds string-type choice items.
For ColumnDefinition
objects, this property is read-only and specifies the data type of the object property
value that is stored in the represented database table column.
For CmIndexPartitionConstraint
objects, this property is read-only and specifies the data type of an index partition constraint.
Only the following values are valid:
DATE
: Specifies a date index partition constraint.STRING
: Specifies a string index partition constraint.The DataType property can have one of the values in the following table.
Name | Value | Description |
---|---|---|
BINARY |
1 | Specifies a binary data type. Represents binary data by using an array of unsigned 8-bit bytes. |
BOOLEAN |
2 | Specifies a Boolean data type. Represents Boolean data having a value of true or false . |
DATE |
3 | Specifies a DateTime data type. Represents an instance in time as a date and time of day in accordance with ISO 8601. |
DOUBLE |
4 | Specifies a double (Float64) data type. Represents an IEEE-standard 64-bit floating-point number, which has a value ranging from -1.79769313486232e308 to +1.79769313486232e308. |
GUID |
5 | Specifies a GUID (ID) data type. Represents a Globally Unique Identifier (GUID) or DCE Universally Unique Identifier (UUID), which is a unique 128-bit number, as a string of 32 hexadecimal characters enclosed by brackets in the following format: {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}. |
LONG |
6 | Specifies an integer data type. Represents a signed 32-bit integer, which has a value ranging from -2,147, 483,648 to +2,147,483,647. |
OBJECT |
7 | Specifies an object data type. Represents an object that is instantiated from a Content Engine class. |
STRING |
8 | Specifies a string data type. Represents text consisting of a sequential collection of 16-bit Unicode characters. |
CmDatabaseConnection
object
on all object stores, event export stores, and isolated regions that will share the same database.
For an isolated region, if the ObjectStore property is set, then the server automatically sets this property and the DatabaseSchemaName property to the same values as the object store's properties of the same name. You cannot change the object store-derived values on this or the DatabaseSchemaName property.
If the isolated region is used by IBM Case Manager, you must set the ObjectStore property. For an isolated region that uses a legacy workflow system, set DatabaseConnection and DatabaseSchemaName to values that reference the legacy system.
Note This property is ignored on DB2 for z/OS.
A unique value is required for database connection sharing. Database connection sharing is initiated when two or more objects are configured to use the same CmDatabaseConnection object.
To distinguish between identically named tables associated with multiple objects that share a database connection, enter a unique, case-insensitive value. The value cannot duplicate the DatabaseSchemaName value of another object using the same database connection. The value will be prepended to database entities, for example, <schema name>.<table name>.
If you do not set a value for an object store, the object store is initialized
using the default schema applied by the database server, and this property is set to
that default schema name provided it is not already in use by another object store
using the same CmDatabaseConnection
object.
For an isolated region, if the ObjectStore property is set, then the server automatically sets this property and the DatabaseConnection property to the same values as the object store's properties of the same name. You cannot change the object store-derived values on this or the DatabaseConnection property.
If the isolated region is used by IBM Case Manager, you must set the ObjectStore property. For an isolated region that uses a legacy workflow system, set DatabaseConnection and DatabaseSchemaName to values that reference the legacy system.
Note This property is ignored on DB2 for z/OS.
For ObjectStore
, this property is deprecated.
Use CmDatabaseConnection.DatabaseType.
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.
COMPLETE
state.
ContentTransfer
object) associated
with this document or annotation was last accessed. The Content Engine stores dates and times using
Coordinated Universal Time (UTC). For more information, see
Timestamps.
The recording granularity of the date and time returned by this property is determined by the setting of the object store's ContentAccessRecordingLevel property. The content data associated with a document or annotation object is considered to be accessed when one of the following events occur:
refresh
method is called with the property filter set to refresh PropertyContent properties
(FilteredPropertyType.CONTENT_DATA
).accessContentStream
method is called to retrieve content data in an input stream.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.
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).
WORKING
state.
The effective time limit is the minimum of this property and the MaxQueryTimeLimit property.
The SQL Timelimit
option in a query overrides DefaultQueryTimeLimit. In that case, the effective limit is the
minimum of the Timelimit
option and the MaxQueryTimeLimit property.
If the Timelimit
option is not set, and neither property is set, the query time is unlimited.
In addition to the time limits that impact client-to-server RPCs, you can set the QueryDatabaseTimeout property, which limits query execution at the database level.
For more information, see Server Query-Timeout Behavior.
ReservationType
constant that indicates, if an explicit choice is not made when a document is checked out, the default
type of reservation to create (collaborative or exclusive) in this object store. For a newly created object store, this property is initialized to EXCLUSIVE
.
The DefaultReservationType property can have one of the following values:
COLLABORATIVE
: Indicates a collaborative reservation, which is a reservation that any user with the appropriate permissions
can check in, modify, or delete.EXCLUSIVE
: Indicates an exclusive reservation, which is a reservation that only the user who checked out the document can check in,
modify, or delete.FixedStorageArea
objects only.)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).
Instead of a retention period, the DefaultRetentionPeriod property can be set to one of the following
RetentionConstants
constants:
INDEFINITE
: Indefinite retention period. Specifies that the instance of the class defined by this class definition
can only be deleted if its CmRetentionDate property has been converted to a expiration date and time and that date and time
is in the past.PERMANENT
: Permanent retention period. Specifies that the instance of the class
defined by this class definition can never be deleted.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.
AreaDeleteMethod
class has constants defined for the deletion method settings.
Valid settings are:
DESTRUCTIVE
: Specifies that content be overwritten once with zeros before it is deleted.PURGE:
Specifies that content be overwritten three times before it is deleted.
This is the most secure form of delete.STANDARD
(default setting): Specifies that content be deleted using the normal
delete operation for the given device or file system. DocumentSet
collection object that contains all of the publication documents to which
this document is the owner document.
DequeueHost
value for each retry,
depending on which server actually processed the queue item.
The text is not locale-specific to the retrieving user except for the following classes:
LocalizedStringList
object containing a collection of LocalizedString
objects, each of which
represents a locale-specific, user-readable description of a class or property.
SourceDocument
property.
This property is not currently supported.
DirectoryConfigurationList
object that specifies the collection of directory server configurations for a given FileNet P8 domain.
This collection represents the type-specific directory server configurations for the supported directory servers
(Microsoft Active Directory, ADAM, CA eTrust, IBM Tivoli, Novell eDirectory, Oracle Internet Directory (OID), and Oracle Directory Server) that will be queried by the Content Engine
server when authorizing user and group names for login.
The value of this property can be any one of the following:
The benefit of using multiple IP addresses for failover is that you do not need to modify a failover list when you change the host name, or when you decommission a domain controller or Tivoli Directory Server. In addition, this option is useful when the Active Directory domain contains remote domain controllers but you want to connect only to local DCs (as opposed to using the "Domain name" option below). The DC connection attempts are done in parallel. The first successful connection is the DC used.
Format the failover list in the following manner:
Hostname1:Port1 Hostname2:Port2 Hostname3:Port3 ... HostnameN:PortN
Separate the host name and port number pairs with one space character. In the following example, the first pair specifies LaurelTree as the machine name and 389 as the port number:
LaurelTree:389 OliveTree:636 FigTree:389
Content Engine makes connection attempts to directory servers based on the order of the pairs in the list. The connection attempts stop when Content Engine either successfully connects to a directory server or exhausts the list. The connection attempts resume at the beginning of the list when Content Engine loses a previously established directory server connection.
For instance, given the example list, Content Engine first attempts to connect to the directory server on the LaurelTree machine on port 389. If that attempt fails, it attempts to connect to the directory server on the OliveTree machine on port 636. If that attempt succeeds, the connection attempts stop. If, later on, Content Engine loses the connection to the directory server on OliveTree, the connection attempts start over again with LaurelTree.
Content Engine ignores this property when the value of the DirectoryServerHost property is a failover list. For information about failover lists, see the DirectoryServerHost property.
DirectoryStructure
class has constants defined for the directory
structure type settings.
Valid settings are:
DIRECTORY_STRUCTURE_SMALL
(default setting): Specifies a small
directory structure. Small structures consist of two levels of directories
with 23 nodes at each level (total of 529 directories at the 2nd level).
Content is stored only at the 2nd level. DIRECTORY_STRUCTURE_LARGE
: Specifies a large directory structure.
Large structures extend the small structure with a third level of 23 nodes,
for a total of 12,167 directories at the 3rd level. Content is stored only at the 3rd level. null
(non-accessible content cache): For the ContentCacheArea
object, this property returns null
when the server cannot physically access the
content cache area and has not previously done so, and the CacheStatus property
setting is Closed
. Note that, although a null
value can be returned,
you cannot set this property to null
. For the ContentCacheArea
object, the directory organization of the
cache permits different servers to work on different directories, and thus allows
cache pruning to be scalable across multiple servers. All of the directories in the
cache contain roughly the same amount of recently added content (as a result of the
cache randomly selecting a directory for new content, and of pruning roughly
the same amount of content from each directory). Pruning, consequently, can occur
independently for each directory and yet still achieve the cache-wide result of
deleting the least frequently requested content.
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.
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:
CFSImportAgentConfiguration
interface, represents a
maximum wait interval. (The minimum interval is always 1 second and cannot be changed).
AsyncProcessingConfiguration
interface, represents a
fixed wait interval. (In effect, represents both the minimum and the maximum wait interval).
The interaction between the minimum and maximum intervals occurs in this
manner: if in the previous processing run the dispatcher had work to perform,
the duration of the subsequent wait interval that the dispatcher actually
remains idle is the minimum interval; otherwise, if the dispatcher had no work to perform,
the duration is the shorter of these two intervals: (a) Double the previous wait interval or
(b) the maximum wait interval. As an example, assuming the minimum interval to be 35 seconds
and the maximum as 120, the dispatcher remains idle for 35 seconds, detects no available work,
remains idle for 70 seconds (double the previous wait interval), detects no
available work, remains idle for 120 seconds (the maximum interval), detects
no available work, remains idle for 120 seconds, detects incoming work and
processes the work, remains idle for 35 seconds, and so on. Note that, when the
minimal interval equals the maximum interval (as is always the case for
the AsyncProcessingConfiguration
interface), this
example can be simplified. If both the minimum and maximum interval is 35
seconds, the dispatcher remains idle for 35 seconds, detects no available
work, remains idle for 35 seconds, detects incoming work and processes the
work, remains idle for 35 seconds, and so on.
For the CFSImportAgentConfiguration
interface, this
property, despite the name, applies to the importer sub-component known as
the import agent and not to the import dispatcher; for information on the
importer sub-components, see the
CFSImportAgentConfiguration
interface.
Name
property of the object's class.
For CmAuditProcessingBookmark
and AuditDefinition
objects, this property is intended to identify client applications
that process the audit log.
For CmAuditProcessingBookmark
objects, this property, in support of the audit disposition feature, identifies the client that created the object.
For AuditDefinition
objects, this property identifies a set of audit definitions for a given client or client functionality.
For CmAuditProcessingBookmark
and AuditDefinition
objects, it is recommended that you set this property.
Specify a unique value to distinguish one client application from another.
Note, however, that the server does not prevent identical display names across multiple
CmAuditProcessingBookmark
or AuditDefinition
objects. Therefore, the client application is responsible for enforcing uniqueness.
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.
WHERE
-clause expression.
If the value of the expression evaluates to true, the audited event is deleted.
The disposition rule is evaluated as a filter expression, and has the same syntax requirements as the FilterExpression property.
The properties referenced in a disposition rule are relative to the event object, not to the event's source object. However, you can reference source object properties that are directly on the event object, for example, the source object class or ID. You can also reference source object properties that have been added to the event as the result of Property Auditing.
The name that uniquely identifies a given group or user. The distinguished name (DN) consists of a group or user's short name and the name of the domain to which it belongs. For example, for a group with the short name "Managers", the distinguished name might be "CN=Managers,DC=example,DC=com".
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.
DocumentLifecycleAction
object associated with this DocumentLifecyclePolicy
object
that holds the definition of the actions to take when a document's lifecycle state changes.
DocumentLifecycleActionSet
object that contains the collection of DocumentLifecycleAction
objects defined in this object store.
DocumentLifecyclePolicySet
object that contains the collection of DocumentLifecyclePolicy
objects associated with this object store or DocumentLifecycleAction
object.
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.
DocumentStateList
object that contains the complete set of valid document states
(each of which is represented by a DocumentState
object) defined by this DocumentLifecyclePolicy
object.
Each document lifecycle policy defines a set of states through which a document can transition into during its lifecycle.
The property supports access of context-sensitive help built into the FileNet P8 Platform documentation. For successful retrieval of a help topic, the client must concatenate the plug-in path of the applicable topic to the base URL of the FileNet P8 Platform documentation server.
To use the FileNet P8 Platform documentation, you can link either to the online version of the information center on www.ibm.com, or to a local copy of the information center that you install and deploy.
To link to a local information center, enter the base URL in the following format:
http://server-name[:port]/application-name/topic/
where:
To install and link to a local information center, see Installing IBM FileNet P8 Platform documentation.
To link to the online information center, enter the base URL of the desired version.
For example, the following URL is for the version 5.1 information center:
http://pic.dhe.ibm.com/infocenter/p8docs/v5r1m0/topic/
For a list of IBM information centers, see Product information.
true
, incoming content is not added to the storage area if identical content already exists in the storage area; only unique content is added.
Consider setting this property to true
for high-volume content ingestion, such as when archiving emails to a Content Engine repository.
However, because this feature impacts server performance, you might want to keep the default setting if the frequency of duplicate content is low.
For the FixedStorageArea
interface, you cannot set the value to true
in this release.
For more information, see Content duplication suppression.
uniquemember
attribute as that which holds the static members of the associated hybrid group.
dxDynamicGroupOfUniqueNames
.
dxMemberURL
attribute. Content Engine server runs this query to retrieve the
dynamic members of the group.
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):
"t3://Server1:7001/FileNet/Engine"
"iiop://Server1:2809/FileNet/Engine"
"jnp://Server1:1099/FileNet/Engine"
Note: In IBM Content Foundation, JBoss is not supported.
The maximum length of the URI string is 2083 characters.
If you set this property on a sweep job, which runs one time only, be careful to allow sufficient time for the the job to process the entire table, especially if the table is very large. If the effective end date does not allow the necessary time, then the job will end before it completely processes the table.
This property can be accessed from a ContentElement
-based object,
or from GetContentEvent
, representing the event fired when the
content element specified in this property is retrieved.
For CmVerityIndexRequest
, this property is deprecated.
User.get_Email()
.
true
) or not (false
).
Setting this property to true
generates a new encryption key, which is used to encrypt new content.
For more information on how content encryption works, see
Content encryption.
null
.
This property is intended for external management of encryption keys by supporting IBM products. In general, a custom application should not use this property, unless there is a compelling reason to supply its own key rather than use a server-generated key.
An encryption key must be 128 bits in length. An incorrect length results in a E_BAD_VALUE
exception.
It is recommended that a Federal Information Processing Standards (FIPS) 140-compliant algorithm be used to generate an encryption key.
Note that an encryption key is used only if the EncryptionEnabled property is set to true
.
If the EncryptionEnabled property is set to false
, the value set on this property is ignored.
If the EncryptionEnabled property is set to true
but this property is not set, then
the server automatically generates the encryption key.
For more information on how content encryption works, see Content encryption.
null
.
Set this property to true to disable replication on federated documents and annotations after the content is moved to a P8 storage area. After moving the content, the server sets the ReplicationGroup property to null on documents and annotations.
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.
EventAction
objects associated with an ObjectStore
object.
Event
object that triggered the queued event action.
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.
In IBM Content Foundation, Case Analyzer and Process Simulator are not supported.
ExternalPropertyAliasList
collection of the external aliases defined for this
property definition or replicable class definition.
ExternalClassDescriptionSet
object containing the set collection of ExternalClassDescription
objects associated with this external repository. Each of these ExternalClassDescription
objects represents the
description of a class in this external repository.
ExternalPropertyDescriptionSet
object containing the set collection of ExternalPropertyDescription
objects associated with this external class description.
ExternalIdentityList
collection of the read-only ExternalIdentity
objects
that represent the identities of replicas of this object in external repositories.
ExternalRepositorySet
object containing the set collection of ExternalRepository
objects
associated with this domain.
ExternalRepository
object that represents one of the following items:
An external repository is a repository that is external to the Content Engine server, such as an IBM® Content Manager OnDemand (CMOD) repository or an IBM® FileNet® Image Services repository.
true
.
For example, if you define the Centera log file name and other logging parameters in a file named CenteraLogging.cfg, you would set the value of this property to be the fully qualified name for that file, such as C:\config\CenteraLogging.cfg, and Content Engine would then pass that file name to Centera. The information logged by Centera to your specified log file can be useful for diagnosing connectivity and performance issues between Content Engine and the Centera fixed content device.
For information on the configuration parameters, see the Centera documentation. The following are some of the parameters currently available:
For example, a configuration file might specify these parameters and
values:
FP_LOGPATH=C:\logs\Centera.log
FP_LOG_STATE_POLL_INTERVAL=10
FP_LOGKEEP=APPEND
FP_LOGLEVEL=1
FP_LOGFORMAT=TAB
true
to
enable logging and false
to disable logging.
When you enable Centera native logging, you must set the value of the FPLogConfigFile property appropriately.
FPPool.Open
to open connections. Possible values are:
FPPool.Open
attempts to open connections to
all addresses in the connection string and all associated replication addresses. Consider using
this strategy if your application performs numerous operations while the pool is open. This
option is the default strategy and is equivalent to FP_OPTION_DEFAULT_OPTIONS.FPPool.Open
opens connections to addresses only
as needed. Consider using this strategy if your application frequently opens and closes the
pool.BlobWriteCollisionAvoidanceFlag
is used in tag
write and only applies to blobs.)
FPClip.Delete
and FPClip.AuditedDelete
) and
the deprecated purge operations (FPClip.Purge
and FPTag.BlobPurge
). Possible values are:
FPClip.Exists
and FPTag.BlobExists
).
Possible values are:
FPPoolQuery.Open
).
Possible values are:
FPClip.Open
, FPTag.BlobRead
,
and FPTag.BlobReadPartial
). Possible values are:
FPClip.Write
and FPTag.BlobWrite
).
Possible values are:
For a related JNDI name, see the FederationJNDIXADataSource property. For information on specifying the external repository, see the SourceRepositoryName property.
For a related JNDI name, see the FederationJNDIDataSource property. For information on specifying the external repository, see the SourceRepositoryName property.
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.
StoragePolicy
, Subscription
, AuditDefinition
CmSweepPolicy
, and CmSweepJob
objects.
For StoragePolicy
, 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 more information, see Storage policies.
For Subscription
, FilterExpression is used to determine
whether the event action should be launched.
For AuditDefinition
, FilterExpression is used to determine
whether an event should be audited.
The filter is applied to either the source object, or, optionally, to the object specified in the
FilteredPropertyId
property of Subscription
or AuditDefinition
.
Note that for version series subscriptions,
the filter is applied to the document version in the transaction and not to the version series.
For Subscription
, the Content Engine server evaluates the filter expression, as follows:
true
, the event action specified by the subscription is fired
or enqueued, as appropriate (depending on whether the event action is set to execute synchronously or
asynchronously).false
or unknown
(typically resulting from a property that has no value),
or if there is an error in the evaluation (such as a syntax error in the expression or an incorrect
reference to a property), the event action is silently discarded.For a sweep job or sweep policy, FilterExpression is used to evaluate each instance
of the sweep-target class. If the value of the expression evaluates to true
,
an operation is applied to the instance. The operation performed depends on the type of sweep.
For AuditDefinition
objects, FilterExpression is only applicable to GetContentEvent
and events of type ObjectChangeEvent
.
If the value of the expression evaluates to true
, the event is audited; otherwise, it is not audited.
The syntax of this property must be a fragment of a SQL where
-clause expression
(for example, VersionStatus = 1
) and use supported operators.
See SQL Syntax Reference.
Note that some operators that are valid in an ad hoc SQL query are not supported in FilterExpression. The following operators are not supported.
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'
For Subscription
and AuditDefinition
objects only, you can use the IsModified
predicate, for filtering events based on modified properties of the source object.
A filter expression using the IsModified predicate must be constructed as follows: IsModified(property), where property can be in any form supported elsewhere in the query, for example, table_alias.property_alias.
Note that the IsModified predicate can only be used in a filter expression. It cannot be used in an ad hoc SQL query.
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 For PublishRequestEvent
, apply the filter expression on the InputDocument
property of the
PublishRequest
object, not on an object-valued property of the source object being published. When you publish a document, a
PublishRequest
object is created, which, at runtime, is the source object on which PublishRequestEvent
is triggered.
FilteredQueryTimeout
can be used to enhance job and policy sweep performance.
When FilteredQueryTimeout
is set to the default value of 0, a sweep first issues queries
to retrieve candidate objects from the database, and next applies the filter expression conditions on the
candidate objects to determine which objects to process.
The following is a sweep query of the Document
class and all subclasses:
SELECT TOP 2000 bcn.Id, bcn.StorageArea, bcn.ReplicationGroup
FROM Document bcn WITH INCLUDESUBCLASSES
WHERE Id > {00000000-0000-0000-0000-000000000000} ORDER BY Id
The query retrieves instances of the Document
class from the database.
If the FilterExpression
property is set on the sweep job or policy, the sweep
uses the filter expression to evaluate the instances (the candidate objects) that were
returned from the database. For the objects that satisfy the conditions of the filter expression,
the sweep processes them as defined by the job or policy .
For example, if a document disposal policy has a filter expression of
IsReserved=TRUE AND ContentSize > 10000
, the disposal policy deletes
only instances that are in the reservation state and have content that is larger than 10,000 bytes.
When the FilteredQueryTimeout
value is greater than 0, then the queries
issued to the database include the conditions of the filter expression in the WHERE clause.
Expanding on the previous example, using a FilteredQueryTimeout
value of 30 seconds
and a filter expression of IsReserved=TRUE AND ContentSize > 10000
results in
the following sweep query:
SELECT TOP 2000 bcn.Id, bcn.StorageArea, bcn.ReplicationGroup, bcn.ContentSize, bcn.IsReserved
FROM Document bcn WITH INCLUDESUBCLASSES
WHERE Id > {00000000-0000-0000-0000-000000000000}
AND (IsReserved=TRUE AND ContentSize > 10000)
ORDER BY Id OPTIONS(TIMELIMIT 30)
Note that the TIMELIMIT value of the query is set to the value of the FilteredQueryTimeout
property (TIMELIMIT 30).
The value of the FilterExpression
property is used to expand the the WHERE clause and the selection list of the query.
When the time limit is greater than 0, it is applied only to the first query of the sweep iteration. If the query time limit is exceeded, then the query terminates and the sweep falls back to using a query that does not contain the filter expression in the WHERE clause. The sweep continues to use the WHERE clause without the filter expression until the iteration is completed. If the query time limit is not exceeded during the first query, then the sweep continues to use the WHERE clause with the filter expression until the sweep iteration is completed.
The use of the FilteredQueryTimeout
property is a trade-off between
the sweep issuing longer-running database queries or evaluating candidate objects before processing them.
If the FilteredQueryTimeout
property is used, each query runs longer because it includes the conditions of the
filter expression in the WHERE clause. However, the sweep job or policy runs faster because it
need not evaluate candidate objects returned by the database before processing them.
If the FilteredQueryTimeout
property is not used, then each query runs faster,
but the policy or job must first evaluate the candidate instances before processing the ones that meet
the filter expression conditions.
For more information, see usage guidelines.
FixedStorageArea
object
or external repository.
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 withFolderCacheReapFrequency
.
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.
Deprecated.
The frequency with which the folder cache is to be purged when the cache exceeds the value ofFolderCacheMaxEntries
. 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.
* \ / : ? " < > |
FolderSet
collection object containing the Folder
objects in which this document is filed.
UpgradeAddOn
object.
The list must contain one or more IDs (and will usually contain only one).
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.
FULLTEXTROWLIMIT
option is specified for a SQL statement, the lesser of this property value and the value
specified for FULLTEXTROWLIMIT
is used as the maximum number of rows that can be returned.
Setting this limit prevents excessive resource use during a search operation. If not changed by the system administrator, the value of this property defaults to infinity.
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.
The value of this property can be any one of the following:
null
, Content Engine uses an internal
mechanism to find a GC.Failover list format
Format the failover list in the following manner:
Hostname1:Port1 Hostname2:Port2 Hostname3:Port3 ... HostnameN:PortN
Separate the host name and port number pairs with one space character. In the following example, the first pair specifies LaurelTree as the machine name and 3268 as the port number.
LaurelTree:3268 OliveTree:3269 FigTree:3268
Content Engine makes connection attempts to GCs based on the order of the pairs in the list. The connection attempts stop when Content Engine either successfully connects to a GC or exhausts the list. The connection attempts resume at the beginning of the list when Content Engine loses a previously established GC connection.
For instance, given the example list, Content Engine first attempts to connect to the GC on the LaurelTree machine on port 3268. If that attempt fails, it attempts to connect to the GC on the OliveTree machine on port 3269. If that attempt succeeds, the connection attempts stop. If, later on, Content Engine loses the connection to the GC on OliveTree, the connection attempts start over again with LaurelTree.
Content Engine ignores this property when the value of the GCHost
property is null
or is a failover list. For information about
failover lists, see the GCHost property.
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:
samAccountName
for the Active Directory service
provider and cn
for all other supported directory service providers.
"(&(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:
Group.Id
property. The default property value
is dependent on the directory server type and is specified by the authentication
provider's configuration. See What are access rights?
for a list of the default SID attributes for the supported authentication providers.
Deprecated.
A boolean that indicates whether the directory server group unique ID attribute is a binary value or a String value. A value oftrue
indicates that the attribute is a binary type;
false
indicates it is a String type.
Group
objects belonging to a given realm or group.
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.
CmHoldable
instance that represents
the held object in this relationship object.
For a Document
type, this references a specific version,
not a version series.
The offsets in the summary text of a text search result, which represent fragments that should be highlighted as hits.
VirtualServer
or ServerInstance
.
CmHold
instance that represents
the hold in this relationship object.
Use the value of this property to help identify all of the Content Engine server instances that are configured on the same host.
ISDomainName
and ISOrganization
properties.
ISDomainName
and ISOrganization
properties.
In most cases, this value will be "FileNet".
For User
and Group
classes, the Id property takes the value of the
Security Identifier (SID) rather than the 128-bit GUID. The string representation of the
SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269
.
When Active Directory is used as the directory service for IBM FileNet P8, calls to
User.get_Id()
and Group.get_Id()
always return the current SID for the
principal, even if this user or group has only historical SIDs populating the Active
Directory server.
For a given property representation, the Id property has the following characteristics:
PropertyDescription.get_Id()
is equal to PropertyTemplate.get_Id()
, which is equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDescription.get_Id()
.
For a newly created document object, you can override the Id property of its associated VersionSeries
object
before you save or check in the document for the first time.
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.
ThumbnailImageColor.COLOR
.
ThumbnailImageFormat.JPEG
.
ImageServicesClassDescriptionList
object, which contains a collection of the Image Services document class descriptions associated
with this FileNet Image Services fixed content device.
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.
ThumbnailImagesSize.SMALL
.
ClassDefinitionSet
object, which contains a
ClassDefinition
object for each class that is an immediate
subclass of the class defined by this ClassDefinition
object.
ClassDescriptionSet
object, which contains a
ClassDescription
object for each class that is an immediate
subclass of the class described by this ClassDescription
object.
com.filenet.engine.content.fcprovider.centera.CenteraFCP
com.filenet.engine.content.fcprovider.is.ImageServicesFCP
com.filenet.engine.content.fcprovider.fsb.SnaplockFCP
true
) or not (false
).
IndexArea
object representing the index area that contains the IBM® Content Search Services index
referenced by the IndexationId
property.
IndexArea
objects that can be used to store full-text indexing information for this object store.
IndexJobItem
.
CmIndexParitionConstraint
objects, each of which represents an index partition constraint associated
with this IBM® Content Search Services index. This list is read-only and is maintained by the Content Engine server.
Only Content Engine objects that satisfy these constraints are indexed into a partitioned IBM Content Search Services
index. An IBM Content Search Services index can have a maximum of one date index partition constraint and one string
index partition constraint. A date index partition constraint specifies a date range to use to partition this index and a
string index partition constraint specifies a name and value to use to partition this index.
null
for objects that are full-text indexed prior to the 4.0 release.
The server sets this property if a string-valued property of this object is CBR-enabled.
An object is considered to be CBR-enabled if you set the PropertyDefinitionString.IsCBREnabled
property of the property definition of one of the object's string-valued properties to true
.
CmTimeslotList
collection specifying a list of CmTimeslot
objects, each of which represents a timeslot
used to schedule a background IBM® Content Search Engine Services indexing task. Each timeslot specifies a
local start time and day (relative to the server running the background task), and a duration.
The list of timeslots controls when the indexing jobs background task is allowed to run,
enabling administrators to schedule heavy indexing loads so they take place during off-peak hours.
If there are no timeslots specified (the default), the indexing job task will run unrestricted and can
run continuously (given enough indexing jobs).
IndexingOperation
constant that specifies the type of operation for this IBM® Content Search Services
index request. The only user-settable value of the IndexingOperation property is SKIP
; otherwise, this property
is read-only.
To skip the indexing of a CBR-enabled object, change the index request operation to a SKIP
operation. After you set the
IndexingOperation property to SKIP
, the Content Engine server sets the CmIndexingFailureCode property of the index
request to MARKED_AS_SKIPPED
and sets the IndexationId property of the CBR-enabled object to null
.
This property can be set to SKIP
only if the IndexRequestStatus property of this index request has a value of
NOT_STARTED
or IN_PROGRESS
.
The IndexingOperation property can have one of the following values:
CREATE
: Indicates that an index entry is to be created.UPDATE
: Indicates that an existing index entry is to be replaced with an
updated entry. An update index request is generated if the CBR-enabled object is modified and has a
non-null IndexationId property value.DELETE
: Indicates that an index entry is to be deleted.SKIP
: Indicates that an index request is to be skipped. The Content Engine server sets the CmIndexingFailureCode
property of the index request to MARKED_AS_SKIPPED
and sets the IndexationId property of the CBR-enabled object to
null
. This value is the only user-settable value.NO_OP
: For internal use only.IndexingStatus
object that specifies the load-balancing status of this IBM® Content Search Services index.
The Content Engine server automatically reassigns an index to another IBM Content Search Services server,
if necessary, to balance the indexing workload of the server. The IndexingStatus property can have one of the following values:
NORMAL
: The index is assigned to an IBM Content Search Services server and does not need to be reassigned.REBALANCING
: The index is in the process of being reassigned to a new IBM Content Search Services server.
When the index is in this state, you cannot change the value of its ResourceStatus property via the API. After the reassignment is
complete, the following properties of the index are changed by the Content Engine server:
NORMAL
.REPLACING
: The index is unavailable and an index job has set the ResourceStatus property of the index to
CLOSED
. When the index is in this state, you cannot change the value of its ResourceStatus property via the API.A value of -2, -3, and less is only allowed on an ACE that is not inherited (that
is, the PermissionSource
value is SOURCE_DIRECT
,
SOURCE_DEFAULT
, or SOURCE_TEMPLATE
) and can be useful
because that InheritableDepth value prevents the permission from affecting the
security parent object itself. For instance, if the permission gave a user the DELETE
right and the InheritableDepth value was -2, then the user would be able to delete
security children objects that inherited that permission, but would not be able to
delete the security parent object itself.
If the permission has been inherited (PermissionSource.SOURCE_PARENT
),
then the InheritableDepth value will always be 0, -1, 1, or other positive value greater
than 1. The value will never be -2, -3, or other negative value less than -3.
For more information about inheritable depth values, see Security Inheritance.
[<task name>(<context>)]
where:
task name identifies the function of the background task by name, such as replication, CFS import, or the specific type of sweep policy, sweep job, or queue sweep.
context provides contextual information applicable to the task type, such as the target source repository or target class processed by the task. If the value exceeds the maximum length of the property, the context portion of the string is truncated.
null
.
AddOn
that installed this object. If null, this object was either created by the system or an external application.
The property setting on the CmSweep
object overrides the property setting on the
CmSweepConfiguration
global object. If the property is set to null on the CmSweep
object,
then the InterBatchDelay setting on the CmSweepConfiguration
object is used.
For classes, the following conditions apply:
true
if any property on this class is going to be enabled for CBR. true
also enables full text indexing of any content associated with the class. (There is no
content property to enable CBR.)For properties, this property can be enabled only on Document
, Annotation
,
CustomObject
, and Folder
objects.
true
) or not (false
). The current version can be a major version or a minor version.
EventAction
object's IsEnabled
property to false
(off) or true
(on).
Likewise, you can enable or disable a subscription, a security template, an audit definition, an audit disposition policy, a change preprocessor definition,
a change preprocessor action, and a sweep. The property defaults to true.
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 code handler 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 code procedures 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.
Disabling a change preprocessor action has system scope, that is, it prevents code handler execution for all class definitions that reference the change preprocessor action. On the other hand, disabling a change preprocessor definition has class scope; it prevents code handler execution for only that class definition, and for any subclass definitions to which the changed property value is propagated.
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.
true
)
or not (false
).
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.
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.
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
.
true
) or not (false
).
If this property is set to true
, all of the IndexJobItem
objects belonging to this index job must
be of type IndexJobCollectionItem
(for Verity collections).
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.
true
) or not (false
).
If this property is false
, only the server can save the state of the object.
true
)
or not (false
). If IsReadOnly
is true
, the property's value can only be changed by the server.
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
).
false
, indicating that SSL is disabled.
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
).
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.
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).
For CmThumbnail
, indicates whether the thumbnail image was automatically generated by the system.
If the image was user generated, that is, generated by a third-party application rather than by the Content Engine,
the system cannot overwrite the image with a different one.
However, a client application can retrieve a CmThumbnail
object and
overwrite the existing image, whether or not the image was system- or user-generated.
true
) or not (false
).
If multiple isolated regions are associated with the same object store (as set on the ObjectStore property), then the isolated regions will share the same database connection as the object store. For the server to distinguish between isolated regions in the same database using the same database schema name, this property must be set to a unique value for each isolated region.
A unique value is not required if the isolated region will not share a database connection with other isolated regions using the same database schema name.
IsolatedRegion
objects associated with a FileNet P8 domain or a database connection.
For ObjectStore
, this property is deprecated.
For ObjectStore
, this property is deprecated.
true
) or not (false
).
If this property is set to true
, the JobStatus property of the index job is set to
IndexJobStatus.PAUSED
. Otherwise, this index job is in progress and its
JobStatus property is set to IndexJobStatus.IN_PROGRESS
.
DYNAMIC_LABEL_CR
.
For all other component relationship types the value of this property is null
. For more information,
see ComponentRelationshipType Property.
IndexJob
and CmIndexRequest
objects, this property identifies the final failure
condition for the index job.
For a ReplicationJournalEntry
object, this property provides a description of the latest failure condition,
if any, for the replication operation that generates this journal entry.
For a CmThumbnailRequest
object, this property states why document thumbnail generation failed.
For a CmTask
object, this property indicates why the object has been set to the exception state.
This property is settable only during the SET_EXCEPTION
changeState transaction, for example:
CmTask.changeState(SET_EXCEPTION);
CmTask.set_LastFailureReason ( "Required document was not attached to workflow.");
CmTask.save();
To reset LastFailureReason to a null value, clear the exception:
CmTask.changeState(CLEAR_EXCEPTION)
.
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).
CmAuditSequence
property on the event object, and set the value on the LastProcessed
property.
The maximum interval, in seconds, allowed for a worker to process a batch before the batch is assigned to another worker. Used for multi-server coordination, this interval ensures that any abnormal termination of the worker previously assigned to the batch does not prevent batch completion.
For VerityServerConfiguration
, this property is deprecated.
UserContext
locale-specific operations as well as the WSDL-defined locale for the web
services SOAP transport.
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.
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.
unlock
), the value of LockToken
is set to null
.
(If the lock expires naturally, then the value remains unchanged.)
ReplicationDirection
constant that specifies the direction in which the property in an external repository that is
described by this external property description can be mapped for replication with respect to a Content Engine property.
This mapping direction can be inbound, outbound, or both.
get_Marking()
on a given ActiveMarking
object returns this object-valued property.
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.
MarkingSet
objects.
The primary use of the 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.
Marking
to an object that has a property
associated with a MarkingSet
. This value of a marking must be unique within a marking set.
MarkingList
object, which contains a collection of Marking
objects.
For VerityServerConfiguration
, this property is deprecated.
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".
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).
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.
FULL
.
Setting this property is optional. A value of -1 indicates no limit.
For VerityServerConfiguration
, this property is deprecated.
FULL
. Setting this property is optional.
A value of -1 indicates no limit.
The effective time limit is the minimum of this property and the SQL Timelimit
option.
If the SQL Timelimit
option is not set, the effective time limit is the minimum of this property and the
DefaultQueryTimeLimit property.
If the Timelimit
option is not set, and neither property is set, the query time is unlimited.
In addition to the time limits that impact client-to-server RPCs, you can set the QueryDatabaseTimeout property, which limits query execution at the database level.
For more information, see Server Query-Timeout Behavior.
FULL
. Setting this property is required.
CFSImportAgentConfiguration
and CmThreadPoolConfiguration
objects.
For a CFSImportAgentConfiguration
object, the MaxWorkerThreads property is 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.
For a CmThreadPoolConfiguration
object, the MaxWorkerThreads property is the maximum of number of threads that can be allocated for processing of background tasks
in the worker thread pool.
concurrent batches per CPE instance = (property value / CPE instances with indexing enabled)
In this calculation, CPE instances with indexing enabled includes all Content Platform Engine instances that are configured with indexing enabled. The property value is the value of the MaximumConcurrentIndexingBatches property. For example, suppose that the property value is 12 and the number of instances with indexing enabled is 2: 12 / 2 = 6 maximum concurrent indexing batches per Content Platform Engine instance.
The calculation does not take into account Content Platform Engine instances that are not running. If one of the instances stops running (because the instance is shut down, for example), the IBM Content Search Services server operates at less than the configured capacity. In the previous example, if one of the Content Platform Engines instances stops running, the remaining instance still sends a maximum of six concurrent batches. The result is that the server operates at 50% capacity. To keep IBM Content Search Services server running at full capacity, disable indexing for any Content Platform Engine instance that might not resume running soon.
Note that this property works in tandem with the
ThreadCount property on the
CmTextSearchConfiguration
class to control the indexing work load for a Content Platform Engine instance.
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.
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.
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.
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.
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
and CmThumbnail
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 set by the Content Platform Engine to the value of the
first content element, regardless of whether it is a ContentTransfer
or ContentReference
object.
Although the Content Platform Engine does not enforce the format of this property's value, a MIME format string consists of a content type, a content subtype, and an optional parameter in the following format: "content type/subtype[;parameter]", for example: "text/html".
MIME defines the following content types:
The following MIME types are specific to FileNet:
ContentReference
content element.ContentReference
content elements only.AccessRight
class in the
com.filenet.api.constants
package. You can:
ModificationAccessRequired
property when creating a given propertyset_ModificationAccessRequired
to modify its value after creating the given propertyClassDefinition
object when creating a document class.When the Import Agent assigns a queued import request to a worker thread, the worker thread acquires a lease on the request. The lease is the number of seconds allotted by the Import Dispatcher for the worker thread to complete its work. If the time expires before the work is completed, the dispatcher can assign the request to another thread. A move operation can take considerable time and can potentially exceed the allotted time. Before attempting the move operation, the worker thread determines how much time remains on the lease, and compares that value to the MoveContentLeaseThreshold property value. If the amount of time is greater than the MoveContentLeaseThreshold value, the worker thread proceeds to execute the work. If the amount of time left is less than the MoveContentLeaseThreshold value, the worker thread relinquishes the lease and allows the Import Dispatcher to reassign the request to another thread.
Attention: Do not change the value of this property without guidance from a support representative. Doing so might adversely affect system performance.
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.
PropertyDescription
object in this ClassDescription
object's PropertyDescriptions
collection that serves as the name property for object instances
of the class. 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.
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).
null
.
For more information about this cache, see Security Caching.
For more information about this cache, see Security Caching.
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.
ObjectStoreParticipant
,
the object store of this object store participant of a replication group.
For an IsolatedRegion
,
the object store associated with the isolated region.
If you set this property, the server automatically sets the
DatabaseConnection and DatabaseSchemaName properties to the same values
as the object store's properties of the same name, even if
DatabaseConnection and DatabaseSchemaName were previously set to
different values. Once set, this property cannot be modified.
If the isolated region is used by IBM Case Manager, you must set the ObjectStore property.
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 Custom Schema Scripts.
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 Custom Schema Scripts.
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 Custom Schema Scripts.
ObjectStore
objects associated with a FileNet P8 domain
or a database connection.
For VerityServerConfiguration
, this property is deprecated.
get_SourceObject
.
To compare the two states of the source object,
fetch the properties of the object returned by get_OriginalObject
and get_SourceObject
.
For CmRecoveryItem
, the original object that was marked for deletion.
To get the original object, the user must have the VIEW_RECOVERABLE_OBJECTS
access right on the object store.
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).
true
) or not (false
).
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.
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).
PEConnectionPointSet
object containing the list of connection points (PEConnectionPoint
instances) available
in this P8 domain.
Folder
object for the folder that directly contains this folder.
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.
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.
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.
CmIndexPartitionConstraintDate
object that is used a date constraint for a partitioned IBM Content Search Services index.
CmIndexPartitionConstraint
objects, the name of a CBR-enabled object property
that is assigned in an object store to act as a partition constraint for an IBM® Content Search Services index.
This property is read-only and is assigned by the Content Engine server when the index is created.
For CmTextSearchPartitionProperty
objects, the name of a CBR-enabled object property
that is assigned in an object store to act as an index partitioning property for IBM Content Search Services.
This read/write property must be a custom string- or date-valued property and have a settability of SETTABLE_ONLY_ON_CREATE
.
You can have no more than one string and one date index partitioning property assigned in an object store.
CmTextSearchPartitionProperty
objects, each of which represents a Content Engine object
property that has been selected to act as an IBM® Content Search Services index partition constraint
for this object store. This list can contain a maximum of one CmTextSearchPartitionDateProperty
object,
representing a custom date-valued index partition constraint property, and
one CmTextSearchPartitionStringProperty
object, representing a custom string-valued index
partition constraint property. Both properties must have a settability of SETTABLE_ONLY_ON_CREATE
.
The source of access rights can be:
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).
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 PersistenceType 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. |
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.
CmTask
object must satisfy before it may be considered complete.
Postcondition expressions are specified in the class definition for the task (as class constant properties).
They cannot be set on a task instance.
A postcondition is evaluated when a CmTask
object is in the WORKING
state, and
changeState(LifecycleChangeFlags.PROMOTE)
is invoked on the CmTask
.
A condition is expressed as an SQL predicate applied to the CmTask
object itself,
or to objects related to the CmTask
through object-valued properties.
For example, if you have a claim processing task that cannot be completed until its ClaimStatus
property is set to CLOSED
, then the postcondition expression would be
ClaimStatus = 'CLOSED'
.
A postcondition has the same syntax requirements as the FilterExpression property.
CmTask
object must satisfy in order to be considered ready to be worked upon.
Precondition expressions are specified in the class definition for the task (as class constant properties).
They cannot be set on a task instance.
A precondition is evaluated when a CmTask
object is in the WAITING_PRECONDITION
state, and
changeState(LifecycleChangeFlags.PROMOTE)
is invoked on the CmTask
.
A condition is expressed as an SQL predicate applied to the CmTask
object itself,
or to objects related to the CmTask
through object-valued properties.
For example, if you have a document approval task that cannot be worked on until its InputDocument
property is set to a released document version, then the precondition expression would be
InputDocument SATISFIES (VersionStatus = 1)
.
A precondition has the same syntax requirements as the FilterExpression property.
CmTaskRelationship
object,
it is reflected in the Successors
property of the CmTask
object that you set on this property.
CmTaskRelationship
object and set its SuccessorTask
property to this CmTask
object,
the newly created CmTaskRelationship
object is added to the enumeration.
OPEN
, cache capacity has not been exceeded, etc.), content
newly added to the main storage area also gets added to the cache area.
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.
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:
PropertyDefinition.get_PrimaryId()
is equal to PropertyTemplate.get_Id()
, which is equal to PropertyDescription.get_Id()
.PropertyDefinition.get_PrimaryId()
is not equal to PropertyDefinition.get_Id()
PropertyDefinition.get_Id()
is not equal to PropertyDescription.get_Id()
.For more information about this cache, see Security Caching.
For more information about this cache, see Security Caching.
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. |
VirtualServer
or ServerInstance
.
Action
-based object is invoked.
For a JavaScript handler that's set on the ScriptText property, set this property to "Javascript".
For a Javaâ„¢ handler, specify the fully qualified name of the Java class that executes.
For a WorkflowEventAction
object, the ProgId must be set to the system-supplied handler,
filenet.pe.ce.wfeventhandler.WorkflowEventActionHandler
.
PropertyDescriptionList
object containing a collection of the property description
objects belonging to all of the subclasses of the class described by this ClassDescription
object.
PropertyDefinitionList
object containing an ordered collection of all of the
property definitions belonging to this class definition.
PropertyDescriptionList
object containing an ordered collection of all of the
property descriptions belonging to this class description.
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.
For ExternalPropertyDescription
objects only, this string is immutable and is unique within
the external class to which the external property description belongs.
BinaryList
object that contains the list of binary values that can be assigned to the
property described by this PropertyDescriptionBinary
object.
BooleanList
object that contains the list of Boolean values that can be assigned to the
property described by this PropertyDescriptionBoolean
object.
DateTimeList
object that contains the list of DateTime values that can be assigned to the
property described by this PropertyDescriptionDateTime
object.
Float64List
object that contains the list of Double (Float64) values that can be assigned to the
property described by this PropertyDescriptionFloat64
object.
IdList
object that contains the list of GUID string values that can be assigned to the
property described by this PropertyDescriptionId
object.
Integer32List
object that contains the list of integer values that can be assigned to the
property described by this PropertyDescriptionInteger32
object.
DependentObjectList
object that contains the set of Content Engine objects that can be assigned to the
property described by this PropertyDescriptionObject
object.
StringList
object that contains the list of string values that can be assigned to the
property described by this PropertyDescriptionString
object.
PropertyTemplate
subclass (PropertyTemplateBinary
,
for example) that specifies the property template on which this property definition is based.
PropertyTemplateSet
object that contains the defined property templates in this object store.
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.
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.
<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.
PublishStyleTemplate
object associated with this publish request.
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
.
Document
object that provided the content for the full-text search.
COUNT_LIMIT
option is set to zero.
You can set this property to the following values:
The default value is twice the value of the QueryPageDefaultSize property.
To optimize result count performance, the administrator must take into account query time limit settings on the server. For more information, see the object store properties DefaultQueryTimeLimit, MaxQueryTimeLimit, and QueryDatabaseTimeLimit.
You can set this property to the following values:
The default value is twice the value of the QueryPageMaxSize property.
To optimize result count performance, the administrator must take into account query time limit settings on the server. For more information, see the object store properties DefaultQueryTimeLimit, MaxQueryTimeLimit, and QueryDatabaseTimeLimit.
You can set this property to the following values:
If this property is set, the effective time limit for each JDBC statement execution is the smaller of any remaining RPC time limit at the time the statement is executed and the QueryDatabaseTimeout value.
This property provides additional control over long-running searches that consume database resources for too long, such as LIKE %value% queries that cause table scans, or complex join queries.
To determine an effective setting for this property, you must take into consideration the time limit for the client-to-server RPC, as set on the DefaultQueryTimeLimit property. The total client-to-server RPC time is composed of the time to parse the Content Engine (CE) SQL into database (DB) SQL, execute the DB SQL, fetch the rows from the database, and check security for each row found. In addition, for a content-based retrieval (CBR) search, the time also includes the full-text search time. Finally, with a paged search, where a fixed amount of rows (typically twice the pagesize) is retrieved from the database at a time, the entire process of DB SQL execution and fetching is repeated if the initial rowset doesn't fill the client page. This can be due to either security filtering or when the initial set of CBR hits do not match the database property criteria.
So as an example, if you were to set the total RPC time limit to 10 minutes, all of the steps described above for the client-to-server search must complete within 10 minutes. At the same time, you could set the QueryDatabaseTimeout value to 30 seconds to specifically limit the DB SQL execution time, because database resource issues (such as blocking) can occur in a smaller time frame.
The typical use-cases of setting a large RPC timeout include long running CBR searches, or non-paged searches that return a large rowset. The typical use-cases for setting QueryDatabaseTimeout is to keep table scans or complex joins from running too long in the database.
The right choices for the RPC timeout and QueryDatabaseTimeout involve considerations from both the P8 Administrator and DBA.
For more information, see Server Query-Timeout Behavior.
For the PublishingConfiguration
object, this property specifies the maximum
number of publish request handler instances.
For the PublishingConfiguration
object, the queue item is a publish request.
Subscription
object that caused a given asynchronous event to be queued.
For the AsyncUpgradeQueueItem
interface, this property is for internal use only.
You can change the rank value range used for IBM Legacy Content Search Engine to match the value range used by IBM Content Search Services. To change this range, add the parameter "-DCBR.RankConsistency=true" to the Java Virtual Machine (JVM) command used by the Content Engine. The rank value range returned by both IBM Legacy Content Search Engine and IBM Content Search Services will then be 0 to 1000.
FAILURE
.
This property is ignored if the sweep job is running in preview mode.
CmRecoveryBin
that contains this object.
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.
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.
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.
RELEASED
.
Note that only one document version at a time in a given version series can be in the released state.
The Content Engine server sets this property if it discovers during an update index request that the current index for the source object is full. When the server attempts to update an index entry in an index that is full, it must instead create a new index entry in an alternative index and delete the original entry in the full index. To ensure that the new index entry is created before the original index entry is deleted, the server performs these tasks in the following order:
IndexRequest
object representing the update index request to the object
ID of the full index.IndexRequest
object representing the update index request to the object ID
of the alternative index.RenditionEngineConnection
object used by this publishing configuration.
RenditionEngineConnectionSet
object that lists the Rendition
Engine connections for this domain.
ReplicationDirection
constant that specifies the direction in which instances of the external
repository class described by this external class description can be replicated: inbound, outbound, or both.
ReplicationGroup
object representing the replication group to
which this replicable object belongs.
ReplicationJournalEntry
objects only, this property represents the replication group
to which the source object of the replication operation generating this journal entry belongs.
ReplicationGroupSet
object containing the collection of ReplicationGroup
objects associated with this domain.
ReplicationMode
constant that specifies the replication mode of the object store
or external repository participant. The replication mode determines how objects are replicated in a replication group.
This constant can have one of the following values:
MASTER
: Master mode. In this mode, replicated objects in the repository can be modified and any
modifications are then propagated to other participants in the replication group.SLAVE
: Slave mode. In this mode, replicated objects in the repository are read-only, and can change only as
a result of the propagation of modifications from another repository operating in master mode in the replication group.ReplicationParticipantsList
collection of ReplicationParticipant
objects,
each of which represents an external repository or object store participant in this replication group.
ReplicationJournalStatus
constant that specifies the processing status of this replication journal entry.
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.
ClassDescription
object describing the class to which object instances must conform
in order to be acceptable values for the object-valued property defined by this PropertyDefinitionObject
object.
Although you can set a RequiredClassId property to any class type, the following restrictions exist:
User
, Group
, EntireNetwork
, or Domain
.
In addition, the referencing PropertyDefinitionObject
must be of single cardinality, not allow foreign objects,
have no reflective property Id ,and have a deletion action of none or null.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.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.
ReservationType
constant that specifies 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 | Specifies a collaborative reservation, which is a reservation that any user with the appropriate permissions can check in, modify, or delete. |
EXCLUSIVE |
32 | Specifies an exclusive reservation. For this type of reservation, only the user who checked out the document can check it in. This user and a user with Full Control access can delete the reservation. |
OBJECT_STORE_DEFAULT |
0 | Specifies that the reservation type is the same as the default reservation type for the object store, which is specified by the DefaultReservationType property. |
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.
ResourceStatus
constant, which indicates the availability status
of an index area, index, or storage area.
For CmTextSearchIndexArea
objects, this property specifies the availability status of an
IBM® Content Search Services index area. This property can hold one of the following values:
OPEN
: The index area is active and new indexes can be created in it. New indexes
can only be created in an index area when this property is set to OPEN
. Existing indexes can also
be updated, deleted, or queried.CLOSED
: The index area is closed to new indexes. However, existing indexes can be updated,
deleted, or queried.FULL
: The index area has reached its full capacity because the number of its indexes
is equal to the value of its MaxIndexes property and all its indexes are either full or closed. This setting
indicates that no more objects can be indexed in the index area. However, existing indexes can be deleted
or queried. Only the Content Engine server can set the ResourceStatus property to FULL
.STANDBY
: The index area is inactive. New indexes cannot be created, but existing entries can
be updated, deleted, or queried. If there are no open index areas available, the Content Engine server can
set the status of an index area that is set to STANDBY
to OPEN
.
For these CmTextSearchIndexArea
objects, the Content Engine server supports only the following
manual transitions between status values:
OPEN
to CLOSED
: This transition is always allowed.OPEN
to STANDBY
: This transition is always allowed.CLOSED
to OPEN
: This transition is only allowed if the value of the MaxIndexes property is greater
than the number of indexes in the index area or there are open indexes in the index area.CLOSED
to STANDBY
: This transition is only allowed if the value of the MaxIndex property is greater
than the number of indexes in the index area or there are open indexes in the index area.FULL
to OPEN
: This transition is only allowed if the value of the MaxIndex property is greater
than the number of indexes in the index area or there are open indexes in the index area.FULL
to CLOSED
: This transition is always allowed.FULL
to STANDBY
: This transition is only allowed if the value of the MaxIndex property is greater
than the number of indexes in the index area or there are open indexes in the index area.STANDBY
to OPEN
: This transition is always allowed, but it should occur
automatically when one index becomes full and a standby index is opened.STANDBY
to CLOSED
: This transition is always allowed.
For CmTextSearchIndex
objects, this property specifies the availability status of an
IBM® Content Search Services index. This property can hold one of the following values:
OPEN
: The index is open for create index requests. New index entries
can only be created in an index when this property is set to OPEN
. Existing index entries can also be updated,
deleted, or queried.CLOSED
: The index is closed for create index requests. However, existing index entries can be updated,
deleted, or queried. If an index job closes an index for deletion, the server sets the ResourceStatus property to CLOSED
and sets the IndexingStatus property to REPLACING
. As long as the IndexingStatus property is set to
REPLACING
, you cannot change the ResourceStatus property from CLOSED
to
OPEN
by using the API. If the index job is canceled, the server sets the IndexingStatus property to
NORMAL
; the ResourceStatus property remains set to CLOSED
unless it is changed by the API.FULL
: The index has reached its full capacity, as defined by the index area
to which it belongs (MaxObjectsPerIndex and MaxSizePerIndexKbytes properties of a CmTextSearchIndexArea
object).
This setting indicates that no more index entries can be created. However, existing index entries can be deleted or queried.
Only the Content Engine server can set the ResourceStatus property to FULL
.UNAVAILABLE
: The index is unavailable for indexing. New indexes cannot be created and existing index
entries cannot be updated, deleted or queried. A query that includes an unavailable index will not fail, but it will not
produce any results. An administrator should inform users when an index has been set to UNAVAILABLE
.
An administrator typically sets an index to the UNAVAILABLE
status to prevent reindexing failures because of a corrupted index.
A corrupted index that has been set to UNAVAILABLE
allows reindexing to complete without
generating an error that can cause the entire reindexing operation to fail. After an index has been set to UNAVAILABLE
,
it cannot be set to any other state; this state is a final state for the index. It is recommended that an unavailable index be reindexed
as soon as possible. The server automatically creates a new index or opens a standby index to handle any pending index requests
for the unavailable index. After an unavailable index is reindexed, the server deletes the unavailable index.
For these CmTextSearchIndex
objects, the Content Engine server supports only the following
manual transitions between status values:
OPEN
to CLOSED
: This transition is always allowed.OPEN
to UNAVAILABLE
: This transition is always allowed.CLOSED
to OPEN
: This transition is only allowed if the index is not scheduled to be deleted
by an index job (that is, the IndexingStatus property is not set to REPLACING
).CLOSED
to UNAVAILABLE
: This transition is always allowed.FULL
to OPEN
: This transition is only allowed if the index is not at full capacity,
as defined by the index area to which it belongs (MaxObjectsPerIndex and MaxSizePerIndexKbytes
properties of a CmTextSearchIndexArea
object).FULL
to CLOSED
: This transition is always allowed.FULL
to UNAVAILABLE
: This transition is always allowed.
For StorageArea
objects, this property specifies the availability status of a storage area.
This property can hold one of the following values:
OPEN
: The storage area is open for new content. Existing content can be updated, deleted,
or retrieved.CLOSED
: The storage area has been disabled or its closure date is set and occurs in the past.
In a closed storage area, new content cannot be created and existing content cannot be updated. However, existing content
can be deleted or retrieved.FULL
: The maximum size or maximum number of content elements in the storage area has been exceeded.
In a full storage area, new content cannot be created and existing content cannot be updated. However, existing content
can be deleted or retrieved.STANDBY
: The storage area is in standby mode. In a standby storage area, new content cannot be
created. However, existing content can be updated, deleted, or retrieved.
For these StorageArea
objects, the Content Engine server supports the following automatic transitions between status values:
OPEN
to FULL
: Applied when adding a content element to a storage area exceeds the maximum size or
maximum number of content elements allowed in the storage area.OPEN
to CLOSED
: Applied when adding a content element to a storage area whose closure date is in the past.STANDBY
to OPEN
: Applied when adding a content element to a storage area and the storage policy contains a
standby storage area but no open storage areas.
For these StorageArea
objects, the Content Engine server supports only the following
manual transitions between status values:
CLOSED
, FULL
, or STANDBY
: These transitions are allowed at any time
(size, count, or closure date limits do not restrict the change).OPEN
: These transitions are allowed only when the size and count are below the specified limits,
and the closure date is in the future (or null
). This restriction includes changes from OPEN
to OPEN
,
which allow you to change limit values for an open area.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
A user can be in a configured realm but belong to a group in an unconfigured realm.
By default (that is, when the property value is false
), the server
automatically searches cross-realm group membership (also called cross-domain group
membership in Active Directory). If it reaches a realm that is not configured in
Administration Console, the 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 server logs an informational message to the
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).
If the AllowRetentionReduction property is set to true, you can use RetentionDurationUpdate to reduce retention. Set this property to a negative value along with the applicable units in the RetentionPeriodUnits property. The server reduces the current retention date by the amount specified in this property.
If the SpecificRetentionDate property is set, the RetentionDurationUpdate property and the BaseDatePropertyName property cannot be set (and vice-versa).
RetentionPeriod
class, are:
FixedStorageArea
objects only.)DurationUnits
constant that specifies the time unit in which the retention duration period (DefaultRetentionPeriod property of a
class definition, or RetentionDurationUpdate property of a retention update policy or retention update job) is expressed. For example,
if the RetentionPeriodUnits property is set to MONTHS
and the DefaultRetentionPeriod property is set to 5, the
retention duration period is 5 months.
This constant can have one of the following values
YEARS
MONTHS
WEEKS
DAYS
HOURS
MINUTES
SECONDS
On a class description, RetentionPeriodUnits is read only.
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.
true
, the service provider returns the names in
DN format, which is consistent with other types of directory service providers.
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.
For CmTextSearchIndexArea
objects, the root directory is used by IBM® Content Search Services servers
to store IBM Content Search Services indexes within a given index area. All the IBM Content Search Services
servers that belong to the same object store site that contains the index area must be given read and write
permissions to this directory. If the root directory that you specify does not exist on your machine, the server will create one.
If you assign an affinity group to an index area, only the IBM Content Search Services servers assigned to that affinity group need to have read and write permissions to the root directory of the index area; it is not necessary to assign permissions to the other servers in the site. When an index area is assigned to an affinity group, it is recommended that you use a root directory that is local for all the IBM Content Search Services servers in the affinity group. Doing so can improve performance because input/output operations are faster for local disks.
Folder
object representing the root of the container hierarchy associated with this object store
Action
-based object is invoked.
false
. To enable cross-forest group membership searches, set this
property to true
.
false
, dynamic groups are not searched.
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.
Deprecated
Identifies the object stores to search. This setting will be overriden by the object store specified for theSearchScope
instance.
Deprecated
Identifies the object type to be queried. This setting will be overriden by the value of theSearchScope
method's searchFromClause
parameter. The following types can be used (one type per search clause):
document
folder
customobject
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
.
Deprecated. Use SecurityFolder
instead.
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.
SecurityPolicySet
object that contains a collection of the security policies
associated with this ObjectStore
object.
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.
FULL
, INHERITANCE
, and NONE
. However, FULL
is for internal use only; do not set the value of this property to FULL
.
For descriptions of each value, see SecurityProxyType.
FULL
on one of its object-valued properties delegates
its access control authority to the object referenced by that property.FULL
.SecurityTemplateList
object that contains a collection of the security templates
associated with a given Security Policy
object.
For a subclass of CmAbstractSequential
, indicates the sequence number of the
entry inserted in the table.
The sequence number can be used to process entries in the order they were created.
A sequence number is assigned to each object at creation, and although the values are not
necessarily consecutive (there might be gaps). they are guaranteed to be unique and
monotonically increasing.
ServerInstance
objects for a given virtual server.
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. |
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.
Document
, Folder
, Annotation
, or CustomObject
object to be indexed.
Site
property defaults to the value of Domain.DefaultSite
.
Note that you cannot change the site directly on an ObjectStore
object.
To move an object store to a different site, you must change this property on the CmDatabaseConnection
object
that is referenced by the ObjectStore
object.
For IsolatedRegion
, this property is deprecated.
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.
Site
objects for this domain. Each element of the collection
represents a geographical area in the domain.
If the SourceObjectStore property is set, then the server automatically sets this property and the SourceDatabaseSchemaName property to the same values as the object store's properties of the same name. You cannot change the object store-derived values on this or the SourceDatabaseSchemaName property.
For Case History, you must set the SourceObjectStore property. To use a legacy workflow system with Case Analyzer, then set SourceDatabaseConnection and the SourceDatabaseSchemaName properties to values that reference the legacy system.
In IBM Content Foundation, Case Analyzer is not supported.
If the SourceObjectStore property is set, then the server automatically sets this property and the SourceDatabaseConnection property to the same values as the object store's properties of the same name. You cannot change the object store-derived values on this or the SourceDatabaseConnection property.
For Case History, you must set the SourceObjectStore property. To use a legacy workflow system with Case Analyzer, then set SourceDatabaseConnection and the SourceDatabaseSchemaName properties to values that reference the legacy system.
In IBM Content Foundation, Case Analyzer is not supported.
get_OriginalObject
on subclasses of ObjectChangeEvent
that provide this method.
For CmSweepResult
, the object that a sweep running in preview mode
selected as a candidate for processing, or that a sweep running in normal mode failed to process.
ObjectChangeEvent
-based event.
You can use this property to identify an object if it no longer exists in the object store.
If you set this property, the server automatically sets the SourceDatabaseConnection and SourceDatabaseSchemaName properties to the same values as the object store's properties of the same name, even if SourceDatabaseConnection and SourceDatabaseSchemaName were previously set to different values. Once set, this property cannot be modified.
For Case History, you must set the SourceObjectStore property.
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.
If the AllowRetentionReduction is set to true, you can use SpecificRetentionDate to reduce retention. Set this property to a value that is nearer to the current date than the value that is set on the CmRetentionDate property of the retainable objects.
null
.
StartMinutesPastMidnight is not an absolute Coordinated Universal Time (UTC), so given the same timeslot, different servers can start at different times, depending on their time zones. In distributed environments, you might want to configure specific timeslots at the specific server instance level to isolate index or disposition processing to non-business-critical periods.
For a storage policy, this represents all storage areas (regardless of the ResourceStatus property value) that the policy references (the filter includes).
StoragePolicySet
object that contains a collection of storage policies
associated with an object store.
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.
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).
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.
Subject
elements are removed to allow more recently used elements to be cached.
SubscribedEventList
collection,
a list of objects representing the system and custom events to which to subscribe.
To disable the subscription cache, set this property to zero.
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.
CmTaskRelationship
object,
it is reflected in the Predecessors
property of the CmTask
object that you set on this property.
CmTaskRelationship
object and set its PredecessorTask
property to this CmTask
object,
the newly created CmTaskRelationship
object is added to the enumeration.
ClassDefinition
object that defines the immediate superclass of the class defined
by this class definition.
ClassDescription
object that describes the immediate superclass of the class described
by this class description.
ExternalClassDescriptions
collection of the external repository.
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.)
The language codes in the following table are supported.
Language code | Language |
---|---|
af | Afrikaans |
ar | Arabic |
ca | Catalan |
zh | Chinese |
cs | Czech |
da | Danish |
nl | Dutch |
en | English |
fi | Finnish |
fr | French |
de | German |
el | Greek |
he | Hebrew |
it | Italian |
ja | Japanese |
ko | Korean |
nb | Norwegian (Bokmal) |
nn | Norwegian (Nynorsk) |
pl | Polish |
pt | Portuguese |
ru | Russian |
es | Spanish |
sv | Swedish |
CmSweepAction
that contains the user-implemented behavior
for a custom sweep.
This property is not supported for this release.
NULL
, the sweep has not completed yet.
The property takes a value of type SweepMode.
This property takes the following values:
Note: If the sweep policy is set to run in preview mode, do not set this property to zero; otherwise, the sweep policy will not generate result records.
null
.
For a sweep job, the property remains set to a timestamp value
even after the job has completed.
CmSweep
object overrides the property setting
on the CmSweepConfiguration
global object.
If the property is set to null on the CmSweep
object,
then the timeslot setting on the CmSweepConfiguration
object
is used.
For objects in which you can set the SymbolicName property (object store, class definition, and property template objects), the value of the SymbolicName property must begin with a letter and contain the following characters only: 'A' to 'Z', 'a' to 'z', '0' to '9', and '_' (underscore). No blanks or symbols are allowed. If you do not provide a value for the SymbolicName property, the server will generate it, based on the value of the DisplayName property, when you save the object. For class definition and property template objects, avoid assigning its symbolic name to a value beginning with one of the reserved prefixes: Cm, Dita, and RM.
For object store objects, the symbolic name for an object store must be unique within a domain.
For class definition objects, the symbolic name for a class must be unique within an object store.
For property template objects, the symbolic name for a property must be unique within a class family only.
A class family is defined by a root class (for example, Document
, Folder
, or CustomObject
)
and all of its descendants. Changing the symbolic name of a property template for a string-valued property that has
been enabled for full-text indexing (IsCBREnabled property set to true
) will require re-indexing of all
objects containing that property. If you do not re-index, full-text searches on this property will fail to find any objects.
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.
true
) or not (false
). This property
corresponds to the COMPression option in a TSM options file.
TivoliFixedContentDevice
object properties are changed. Because the TSM server cannot run if
these files are missing or damaged, you should back them up frequently.
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.
This property can have one of the following values:
TableDefinition
object for the database table in which this ClassDefinition
or
PropertyDefinition
object resides.
TableDefinition
objects used by the object store. This collection represents all of the database
tables used by the Content Engine.
Enabling table overflow support could slightly degrade database performance. It is recommended that you first consider metadata design options before enabling this support.
For a DynamicReferentialContainmentRelationship
or ReferentialContainmentRelationship
object, this is always a Folder
object.
For a Link
object, this can be any subclass of IndependentObject
.
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 argetAccessRequired property, call the property accessor methods on
PropertyDefinitionObject
.
On PropertyDescriptionObject
, TargetAccessRequired is read only.
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.
CmTask.changeState
method.
The states are defined by the Content Engine server.
For a description of the possible states, see the TaskState
class.
AccessPermissionDescription
objects to be used when creating a security template.
AccessPermission
objects to be used when creating a
security template.
CmTextSearchAffinityGroup
objects, each of which represents an affinity group that has been created in this domain.
This list is maintained by the Content Engine server.
true
) or not (false
).
CmTextSearchIndexList
collection specifying a list of CmTextSearchIndex
objects, each of which represents an IBM® Content Search Services
index that has been created in this index area.
Ensure that the languages that you specify with this property match the languages of most of the documents in this object store; otherwise, you might experience a performance delay. If you do not set this property to at least one language code, and the deprecated TextSearchIndexingLanguage property has not been previously set, an error will occur during indexing.
The TextSearchIndexingLanguages property can specify one or more of the language codes in the following table.
Language code | Language |
---|---|
af | Afrikaans |
ar | Arabic |
ca | Catalan |
zh | Chinese |
cs | Czech |
da | Danish |
nl | Dutch |
en | English |
fi | Finnish |
fr | French |
de | German |
el | Greek |
he | Hebrew |
it | Italian |
ja | Japanese |
ko | Korean |
nb | Norwegian (Bokmal) |
nn | Norwegian (Nynorsk) |
pl | Polish |
pt | Portuguese |
ru | Russian |
es | Spanish |
sv | Swedish |
INDEX_AND_SEARCH
(0): The server performs both indexing and search tasks.
IBM does not recommend this usage mode for a general production system.INDEX
(1): The server performs only indexing tasks.SEARCH
(2): The server performs only search tasks.DISABLED
(true
) or not (false
).
Because the Content Engine server does not attempt to restart the IBM Content Search Services server
once it is shut down, use caution if you set the TextSearchServerShutdownOnDisable property to true
.
ENABLED
(0): The IBM Content Search Services server is enabled and can be specified
by its usage mode (TextSearchServerMode property). If you set this property to ENABLED
,
the Content Engine server verifies that there is a connection to the IBM Content Search Services
server. If the Content Engine server cannot connect to the IBM Content Search Services server,
it automatically sets this property to UNAVAILABLE
.DISABLED
(1): The IBM Content Search Services server is disabled for maintenance purposes.UNAVAILABLE
(2): The IBM Content Search Services server cannot be reached.
The Content Engine server automatically sets this property to UNAVAILABLE
if it cannot communicate with the
IBM Content Search Services server. If the connection to the IBM Content Search Services server is reestablished, the
Content Engine server automatically sets this property to ENABLED
. This property can be set to UNAVAILABLE
only by the Content Engine server. If you attempt to set this property to UNAVAILABLE
by using the API, an error occurs.When setting this property by using the API, the Content Engine server supports only the following manual transitions between status values:
ENABLED
to DISABLED
DISABLED
to ENABLED
UNAVAILABLE
to ENABLED
UNAVAILABLE
to DISABLED
CmTextSearchServer
objects, each of which represents an IBM® Content Search
Services server used in this domain. This list is maintained by the Content Engine server and is read-only.
IBM Content Search Services objects can be added to or removed from this list by manipulating the
server CmTextSearchServer
objects directly by using the API.
Content Platform Engine automatically scales the number of worker threads based on index server status to avoid overloading IBM Content Search Services with incoming work. This automatic scaling uses the value of the ThreadCount property as a base value in accordance with the following calculation:
Maximum workers per CPE instance = base value * (running CSS servers / configured CSS servers)
In this calculation, CPE instance refers to a Content Platform Engine instance, and CSS server refers to an IBM Content Search Services index server. Configured CSS servers include all registered index servers that have a status of either UNAVAILABLE OR ENABLED (that is, any status other than DISABLED). Running CSS servers include all configured servers that have a status of ENABLED. For example, suppose that you register four index servers with Content Platform Engine, enable them, and set the base value to 20. In the normal situation, all configured CSS servers are running, and the calculated maximum number of worker threads is the same as the base value: 20 * (4 / 4) = 20. Otherwise, if not all configured CSS servers are running, the calculated maximum is some fraction of the base value. For instance, if only three index servers are running, the calculated maximum is 15: 20 * (3 / 4) = 15.
Note that this property works in tandem with the
MaximumConcurrentIndexingBatches
property on the CmTextSearchServer
class to control the indexing work load for a Content Platform Engine instance.
It is not necessary for the number of maximum worker threads for indexing to be equal to the number of concurrent batches.
Given sufficient computing resources, having more worker threads across all of the Content Platform Engine instances than the number
of concurrent batches is healthy.
If this property is not set, then the directory specified in the ContentTempDirectoryRoot property is used.
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).
UpgradeAddOn
object. The list must contain one or more IDs (and will usually contain only one).
FolderSet
collection object containing the directly-contained Folder
objects that are the
starting points (children of the root folder) in the container hierarchy.
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.
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.
ClassDefinitionSet
object representing the classes that have a property
constructed from this property template.
samAccountName
uid
cn
cn
cn
cn
null
value if it has never been set.
The values of the UserDomain, UserName, and UserPassword properties are used by
Content Engine servers to authenticate with the IBM Legacy Content Search Engine for indexing and search operations.
"(&(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:
For more information about this cache, see Security Caching.
For more information about this cache, see Security Caching.
User.Id
property. The default property value
is dependent on the directory server type and is specified by the authentication
provider's configuration. See What are access rights?
for a list of the default SID attributes for the supported authentication providers.
Deprecated.
A boolean that indicates whether the directory server user unique ID attribute is a binary value or a String value. A value oftrue
indicates that the attribute is a binary type;
false
indicates it is a String type.
User
objects belonging to a given realm.
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.
filenet.vw.api.VWSession
interface's transfer method).
VerityDomainConfiguration
object to exclude any broker
from Content Engine use.
VerityMasterAdminServerHostname
. This is the list of brokers returned from Verity.
VerityCollection
objects associated with this index area. Each Verity collection is a
member of only one index area.
ObjectStore
object, the VerityDomainConfiguration
object that contains the IBM Legacy Content
Search Engine configuration properties for a Verity domain. The configuration determines the Verity domain used by
the object store. More than one object store can share the same Verity domain configuration.
For a Domain
object, this property is deprecated. Use this property on an ObjectStore
object to assign a Verity domain configuration to an object store.
VerityDomainConfigurationSet
collection object that contains the VerityDomainConfiguration
objects for the FileNet P8 domain. A newly created VerityDomainConfiguration
object is added to this set
automatically when you save the object.
VerityMasterAdminServerHostname
property. This list of index servers is returned by Verity.
VerityMasterAdminServerHostname
.
Time intervals span integral numbers of months, without spanning year-end boundaries. The possible values are null, 0, 1, 2, 3, 4, 6, or 12. A value of 1 generates collections spanning one-month intervals, a value of 2 generates collections spanning two-month intervals, and so on. For example, if the date associated with an indexable document is December 15th, 2008, and VerityPartitionInterval is 3 months, then the document would be indexed in the collection with a start date of October 1, 2008 and a stop date of January 1, 2009.
The default is null
, indicating that the partitioning feature is disabled.
A value of 0 also disables the partitioning feature. Setting a value other than those listed above results
in an E_BAD_VALUE
exception.
You can change the VerityPartitionProperty property value after the ObjectStore
object has been created.
The property affects all index areas configured on the object store. The default is null
, indicating that the partitioning feature is disabled.
VerityMasterAdminServerHostname
property. This list of index servers is returned by Verity.
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:
LATEST_VERSION
: All document versions, major and minor, are considered candidates for binding.LATEST_MAJOR_VERSION
: Only the major document versions are considered candidates for binding.VersionSeries
object that contains all of the document versions associated with this
document or DynamicReferentialContainmentRelationship
object.
For other versioning-related events, the ID of the version series for the source object.
Note that this property has a valid value only when the event's source object
is an instance of Document
or its subclass.
This property is null for non-versionable objects.
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. |
VersionableSet
object that contains all of the document versions associated with
this document or version series.
VirtualServer
objects for a given site.
Weekday
enumerated type
(Weekday.SUNDAY
, Weekday.MONDAY
, etc.)
SubscriptionSet
collection containing the workflow subscription
(InstanceWorkflowSubscription
and/or ClassWorkflowSubscription
) objects
associated with a workflow definition.
XMLPropertyMappingScript
object applies.
The value of this property can be one of the following:
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.