This topic alphabetically lists all of the Content Engine API properties. Each property has a See Also section that lists the classes to which the property applies, and provides links to the list of properties for each class. Note that because the metadata for a property is class-specific, you must navigate to the list of properties by class for property metadata information.
[A] [B] [C] [D] [E] [F] [G] [H] [I] [J] [L] [M] [N] [O] [P] [Q] [R] [S] [T] [U] [V] [W] [X]
See Also
This property works in conjunction with the TempFileLifetime property to determine which files get deleted as part of a periodic cleanup.
See Also
This property works in conjunction with the TempDBContentLifetime property to determine which temporary content gets deleted as part of a periodic cleanup.
See Also
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.See Also
AccessPermission
object.
See Also
Each FileNet P8 Site
instance maps to 0 or 1 DNS site. If more than one site is
configured for the FileNet P8 domain, and these sites are in different geographical locations,
LDAP communication between the application server and the directory server might go across a WAN
and performance might suffer.
To alleviate this, you can set this property, which causes the API to search for all domain controllers for the
given domain under that site. For example, you could set the value of this property to "Chicago".
All domain controllers for the given domain under "CN=Chicago,CN=Sites,CN=Configuration,DC=..."
are tested by attempting a connection. The first running domain controller is selected.
See Also
ActiveMarking
objects currently applied to a given object.
Each ActiveMarking
object represents a marking that is in a MarkingSet
associated
with a property on the object.
See Also
See Also
AddOnInstallationRecord
objects corresponding to this object store.
See Also
See Also
See Also
See Also
ReplicationDirection
constant that indicates the direction in which the mapping
applies for this class or property alias.
See Also
IdList
object containing a list of optional alias IDs for this class definition,
property definition, or property template. Depending on the type of object to which it belongs, an alias
ID is set equal to the PrimaryId of another property definition, the Id of another property template, or the
Id of another class definition in another object store to equate the two properties or classes as being the
same entity in multiple object store searches (see the SearchScope
class).
See Also
Realm
objects for the EntireNetwork
object.
See Also
true
) or not (false
).
The default is true
.
See Also
See Also
See Also
See Also
See Also
See Also
See Also
Because the positional index of a given content element within a document's ContentElementList
collection is subject to change,
it is recommended that you populate this property with the value of the content element's ElementSequenceNumber
property rather than its positional index. The value of the ElementSequenceNumber property is server-generated and
provides a unique and unchanging number for a given content element. Because the number of content elements of a document
is variable, if you choose to use a positional index it is up to your application to ensure that it accurately reflects the correct index of
the content element to which the annotation applies. For example, if the AnnotatedContentElement property specifies the
positional index of the third content element of a document with five content elements, and the second content element is then removed,
the property will consequently reference the wrong content element.
See Also
IndependentObject
object of type Document, Folder, or CustomObject to which this annotation has been applied.
See Also
AnnotationSet
object that contains the annotations associated with this object.
See Also
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.
See Also
See Also
See Also
VersioningSecurityTemplate
, the state can be one of the following:
VersionStatusId.IN_PROCESS
VersionStatusId.RELEASED
VersionStatusId.RESERVATION
VersionStatusId.SUPERSEDED
For an ApplicationSecurityTemplate
, the state is defined by your application.
See Also
See Also
See Also
See Also
See Also
Note: If all audit definitions for a class specify that neither failed nor successful operations should be logged, then auditing for the class is effectively disabled.
See Also
ObjectStore
object.
See Also
See Also
CenteraFixedContentDevice
object. If the string is blank, audited delete will not be
invoked (FPClip.Delete
will be used). Otherwise, the string will be used as the prefix
of the delete reason passed to FPClip.AuditedDelete
(the document ID GUID is appended
to the prefix string to form the complete delete reason text).
See Also
EventSet
collection of the Event
objects containing the audited events that have occurred for the
object.
See Also
VerityCollection
instance. There will only be one ID value in this property
for release 4.0 (or later) installations. For installations upgraded from a release prior to 4.0, there may be both
Annotation
and Document
class ID values in this property, since these releases stored indexing
information for both the Annotation
and Document
objects in the same Verity collection.
See Also
See Also
The maximum number of batches that are selected by the import agent dispatcher from the database in a single database round trip.
See Also
FPTag.BlobRead
. If the content size is less than or equal to the parameter value,
the entire blob is read using a single call (a buffer of content size must be allocated), and the data
is passed back via the callers data stream as requested. If the content size is greater than the
parameter value, FPTag.BlobReadPartial
is used to read only the data of the size requested by
the caller (no buffer is created).
See Also
CenteraFixedContentDevice
object. When
creating Centera content, the provider combines this value with FP_OPTION_CLIENT_CALCID_STREAMING
to form the options parameter of FPTag.BlobWrite
. There are three possible values:
See Also
See Also
VerityIndexArea
objects are created, and may not be modified while any VerityIndexArea
objects exist.
If the locale is "uni" the default language code can optionally be appended to this name (such as "uni/fr" for
French). When a language code is appended, queries use the specified language as the default language for word stemming and other
language-specific features.
Specifying a language code here applies only to the default language used. It does not preclude the use of additional languages for the object store. Multiple languages can be indexed into Verity collections in the same object store.
See Also
See Also
See Also
See Also
See Also
See Also
See Also
For more information on CFS interaction with an external IBM Content Integrator repository, see the
IICEFixedContentDevice
interface.
See Also
CMODApplicationGroupSet
object containing the set collection of application groups defined
in the IBM® Content Manager OnDemand (CMOD) external repository associated with this CMOD
fixed content device.
See Also
See Also
See Also
See Also
See Also
See Also
See Also
page_cache<n>:<domain>:<organization>
.
There must be no more than one local CSM cache name for a given value of <domain>:<organization>
.
For example, for domain ntvaga
and organization FileNet
, the names are of the form
page_cache<n>:ntvaga:FileNet
, where <n>
is an unsigned decimal integer
greater than or equal to 2. The default CSM cache on the document server is page cache number 1 (for example,
page_cache1:ntvaga:FileNet
).
This property will be used when the Content Engine server is running within the site identified by this object's Site property.
If a FileNet Image Services fixed content device is made available across multiple sites in a FileNet P8 domain,
you should create an ImageServicesSiteSettings
object for each site that has a local CSM cache.
This SiteSettings
object will override the value of the CSMCache property for the site to enable a
local CSM cache to be utilized.
See Also
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.See Also
Site
accepts forwarded requests. The value of this property is true
if the Site
accepts forwarded requests; otherwise, it is false
(the default). The
property value must be explicitly set to true
when configuring the domain for request forwarding.
Request forwarding must be enabled at the site level (both for forwarding requests and for receiving forwarded requests), and each virtual server within the site must have a valid URI specified in its EJBForwardingEndPoint property to be able to receive forwarded requests.
See Also
true
) or not (false
). A value of true
indicates
that a document's lifecycle state can be changed to the previous state that is defined by its document lifecycle policy.
See Also
true
if the Site
can forward requests; otherwise, it is false
(the default). The
property value must be explicitly set to true
when configuring the domain for request forwarding.
Note: If the value is false
, no requests may be forwarded from
any virtual server in the site.
See Also
Cardinality
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. |
See Also
STATIC_CR
, DYNAMIC_CR
, or DYNAMIC_LABEL_CR
.
For all other component relationship types the value of this property is null
. For a URI
component relationship type, you designate the child component by setting the
URIValue property.
For a ComponentRelationship
object whose relationship type is STATIC_CR
,
set the value of this property to the specific document version to bind to the parent component document.
For a ComponentRelationship
object whose relationship type is DYNAMIC_CR
,
some version of the child document must be eligible-for-binding; otherwise, calling the save
method on
the ComponentRelationship
object throws an exception. For example, a major version of the
document must exist when the version bind rule specifies only major versions can be bound. For information on
the version bind rule, see VersionBindType Property.
When you call the save
method, the ChildComponent property is automatically updated to reflect the actual document version bound.
For a ComponentRelationship
object whose relationship type is DYNAMIC_LABEL_CR
,
no version of the child document need be eligible-for-binding. When you call the save
method,
the value of the ChildComponent property is automatically updated to null
or to the actual
document version bound. This bound version is the most recent version of the child document satisfying the
version bind rule that has a ComponentBindingLabel property value matching the LabelBindValue property value.
For more information on document binding, see
ComponentRelationshipType Property.
Note that, when the ChildComponent property value has been updated to null
, you can still determine
the child document for this relationship by using the ChildVersionSeries property.
See Also
DocumentSet
collection object that contains the child Document
objects bound to this parent document. The collection contains only those child documents for which the
user has read access. For each ComponentRelationship
object that references
this document as the parent component document, the collection contains the version of the child
component document that is bound to this parent document. The same child document can be in the
collection more than once.
For information on the ordering of the collection, see ComponentSortOrder Property.
See Also
ComponentRelationshipSet
collection object that contains the ComponentRelationship
objects referencing this document as the parent component document.
For information on the ordering of the collection, see ComponentSortOrder Property.
See Also
VersionSeries
object that is the version series of the child component document.
Retrieving this property's value is equivalent to calling get_ChildComponent().get_VersionSeries()
.
This property applies when the ComponentRelationshipType property setting is DYNAMIC_CR
or
DYNAMIC_LABEL_CR
; otherwise, the property value is null
.
See Also
Choice
object that holds an integer data type in a choice list.
See Also
ChoiceList
object that represents the discrete set of possible values
that this property can hold.
See Also
ChoiceListSet
object containing the set of ChoiceList
objects defined in this object store.
See Also
Choice
object that holds a string data type in a choice list.
See Also
ChoiceType
constant that determines the type of data that a Choice
object represents:
an integer-type choice item, a string-type choice item, a group node for a nested collection of integer-type Choice
objects,
or a group node for a nested collection of string-type Choice
objects.
The ChoiceType property can have one of the values in the following table.
Name | Value | Description |
---|---|---|
INTEGER |
0 | Specifies a Choice object that represents an integer-type choice item. |
MIDNODE_INTEGER |
2 | Specifies a Choice object that acts as a group node for a nested collection of integer-type
Choice objects. Each Choice object in this collection must represent either an integer-type
choice item or a group node for a nested collection of integer-type Choice objects. |
MIDNODE_STRING |
3 | Specifies a Choice object that acts as a group node for a nested collection of string-type
Choice objects. Each Choice object in this collection must represent either a string-type
choice item or a group node for a nested collection of string-type Choice objects. |
STRING |
1 | Specifies a Choice object that represents a string-type choice item. |
See Also
ChoiceList
object representing a set of allowable values.
If it is associated with a property, ChoiceValues
provides a discrete set of possible
values that the property can hold. Otherwise, if a ChoiceValues
is associated with
a Choice
object, it defines the set of possible values in a choice list group.
See Also
Class Definition
of the class to be indexed. Note that you do not have to fetch the ClassDefinition
to set this property; instead, call the set_ClassDefinition(Factory.ClassDefinition.getInstance)
method on this
IndexJobClassItem
instance.
See Also
ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
See Also
ClassDescriptionSet
object, which contains a collection of the
ClassDescription
objects associated with a given object store.
The ClassDescriptions
property returns a "snapshot" of the latest class metadata
for a given object store. If you make changes to a class, it will not be reflected in
the ClassDescriptions
collection until you refresh the object store.
See Also
See Also
For ExternalClassDescription
objects only, this string is immutable and is unique within
the repository in which the external class description belongs.
See Also
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
.See Also
See Also
Action
-based object is invoked.
A CodeModule
object represents a user-implemented
Java action handler that is checked into the Content Engine.
See Also
See Also
See Also
See Also
See Also
See Also
ColumnDefinitionList
collection object containing the ColumnDefinition objects that describe the columns in the
table.
See Also
See Also
See Also
See Also
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.See Also
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).See Also
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.
See Also
ComponentRelationship
object within the ChildRelationships
collection as well as the position of the child component document within the ChildDocuments
collection. These collections belong to the parent component document. Relative to any other object having the
same sort order number, the binary value of the ComponentRelationship
object's Id property
determines the ascending sort order position for this object and the associated child component.
This property cannot be set to null
.
For a new ComponentRelationship
object with no explicitly set component sort order,
calling the save
method on the object assigns a value to this property equal to the highest component
sort order in the ChildRelationships
collection plus 1000. For example, if you did not explicitly set the
ComponentSortOrder property for any ComponentRelationship
objects within the collection, the
first object added to the ChildRelationships
collection has a component sort order of 1000; the second,
2000; the third, 3000; and so on.
See Also
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
.See Also
See Also
GenericFixedContentDevice
object. There is
no fixed format for this property (other than, it must be a string that the custom implementation of
the fixed content provider can understand and parse).
See Also
See Also
When getting back a collection of domain controllers for a given domain, use this property in an LDAP connection request to determine if a given domain controller in the domain is up and running. If a timeout exception occurs in the specified time, assume the domain controller is not running and try the next one.
See Also
If a given user does not have the appropriate rights to perform marking-related
operations on the object, the access rights specified in the marking's ConstraintMask
property are removed from the user's access rights for that object.
See Also
DocumentSet
collection object containing the Document
objects contained within this folder.
See Also
ReferentialContainmentRelationshipSet
collection object containing the
ReferentialContainmentRelationship
objects contained within this folder.
See Also
ReferentialContainmentRelationshipSet
collection object containing the
ReferentialContainmentRelationship
objects that identify the containers of this object.
See Also
For a DynamicReferentialContainmentRelationship
or ReferentialContainmentRelationship
object, this is the name of the head object in the relationship. The default value is supplied as follows:
If both the Name
and MimeType
property of the Head
object are present and
not zero length, the default value is Name.MimeType (where the MimeType
value is a normalized representation).
If the MimeType
property value is not present, the default is the Name
value of the
Head
object. If the Name
value is not found; the Id
value of the
Head
object is used.
The following characters are not allowed:
\ / : * ? " < > |
Note: If AutoUniqueName.AUTO_UNIQUE
is set when the object is filed, the server attempts to
make this containment name unique.
For an Event
object generated from the FileEvent
and UnfileEvent
event
classes, the value of this property is the name of the
Containable object added or removed.
See Also
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.
See Also
See Also
ContentCacheArea
objects associated with the FileNet P8 domain.
See Also
See Also
For a ContentCacheArea
object, this property returns null
when the server
cannot physically access the cache storage area and the CacheStatus property
setting is Closed
. Also, this statistic, along with the statistic concerning
content element size (the ContentElementKBytes property), can become
inaccurate as the result of power failures; properly timed failures will prevent
servers from keeping the statistics in perfect sync with content creations and
deletions. A cache sweep updates the statistics every 60 days to keep them reasonably accurate.
See Also
For the ContentCacheArea
object, this property returns null
when the server cannot physically access the cache storage area and the CacheStatus
property setting is Closed
. Also, this statistic can become inaccurate;
for more information, see the ContentElementCount property.
See Also
ContentElementList
object containing the list of content elements associated with
this document or annotation. Each content element represents content data, which can either be local
to an object store and stored in a file store or database (represented by a ContentTransfer
object)
or external to an object store and therefore outside the control of the Content Engine server
(represented by a ContentReference
object).
See Also
See Also
For the ContentCacheArea
object, a cache clearing operation initializes this
number to 0 (zero). For information on cache clearing, see the
CacheStatus property. For
information on the potential inaccuracy of this number, see the
ContentCacheArea class.
See Also
StringList
object containing the MIME type of each content element
associated with this document or annotation at the time it was last saved.
See Also
ContentReference
object.
See Also
See Also
See Also
ContentTransfer
object.
Note that if the document or annotation has more than one content element, then the size is the sum of all of the content elements.
See Also
See Also
See Also
When the value for this property is null, the server uses the FileNet working directory as the directory root for temporary content.
See Also
MIME is a communications protocol that allows for the transmission of data in many forms, such as audio, binary, or video. A MIME format string consists of a content type, a content subtype, and an optional parameter in the following format: "MIME::content type/subtype[;parameter]". For example: "MIME::text/html".
MIME defines the following content types:
FileNet-specific MIME types include:
ContentReference
content element.ContentReference
content elements only.See Also
For a PropertyDefinition
object, a value indicating whether the value of the property defined by this
property definition should be copied, during checkout, from the source document to the newly created reservation object.
For a ComponentRelationship
object, a value indicating whether this object gets copied, during
checkout of the parent component source document, for the newly created reservation object. The reservation object
becomes the parent component for the new copy of this ComponentRelationship
object. Consequently,
both the reservation object and the source document have an equivalent component relationship with the same child document.
Note that the reservation object behaves like any other document with respect to compound document properties and relationships.
See Also
Settability of this property is read-only for most users. For users who have been
granted privileged write access (AccessRight.PRIVILEGED_WRITE
), this property is
settable only on create. After initial object creation, this property is read-only for all users.
See Also
DocumentState
object representing the
current lifecycle state of this document.
See Also
See Also
See Also
See Also
See Also
-Xmx512m
.
See Also
DITARenditionEngineConnection
object used by this publishing configuration.
See Also
DITARenditionEngineConnectionSet
object that lists the
DITA Rendition Engine connections for this domain.
See Also
See Also
See Also
TypeID
constant, which indicates the data type of the value that an object property,
choice list, or database table column can hold.
For PropertyDescription
, PropertyDefinition
, and PropertyTemplate
object types,
this property is read-only and specifies the data type of the value that an object property can hold.
Because the value of the DataType property is automatically set by the server to correspond
to the specific object type of the PropertyDescription
, PropertyDefinition
,
or PropertyTemplate
object, you do not need to set it when you are creating a property template or
property definition. For example, in a PropertyDescriptionBinary
, PropertyDefinitionBinary
,
or PropertyTemplateBinary
object, the server automatically sets the DataType property
to a value of BINARY
.
For ChoiceList
objects, this property is settable on create and must be a LONG
or
STRING
constant value. This property determines whether a choice list is an integer-type choice list, which holds
integer-type choice items or a string-type choice list, which holds string-type choice items.
For ColumnDefinition
objects, this property is read-only and specifies the data type of the object property
value that is stored in the represented database table column.
The DataType property can have one of the values in the following table.
Name | Value | Description |
---|---|---|
BINARY |
1 | Specifies a binary data type. Represents binary data by using an array of unsigned 8-bit bytes. |
BOOLEAN |
2 | Specifies a Boolean data type. Represents Boolean data having a value of true or false . |
DATE |
3 | Specifies a DateTime data type. Represents an instance in time as a date and time of day in accordance with ISO 8601. |
DOUBLE |
4 | Specifies a double (Float64) data type. Represents an IEEE-standard 64-bit floating-point number, which has a value ranging from -1.79769313486232e308 to +1.79769313486232e308. |
GUID |
5 | Specifies a GUID (ID) data type. Represents a Globally Unique Identifier (GUID) or DCE Universally Unique Identifier (UUID), which is a unique 128-bit number, as a string of 32 hexadecimal characters enclosed by brackets in the following format: {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}. |
LONG |
6 | Specifies an integer data type. Represents a signed 32-bit integer, which has a value ranging from -2,147, 483,648 to +2,147,483,647. |
OBJECT |
7 | Specifies an object data type. Represents an object that is instantiated from a Content Engine class. |
STRING |
8 | Specifies a string data type. Represents text consisting of a sequential collection of 16-bit Unicode characters. |
See Also
See Also
See Also
Note: This property is ignored on DB2 for z/OS.
See Also
See Also
See Also
See Also
Note: This property is ignored on DB2 for z/OS.
See Also
See Also
See Also
The server sets this property on a document version when it is checked in and it remains set throughout the life of the document version. When a document is checked out, the server sets this property on the document's reservation object to null.
Settability of this property is read-only for most users. Users who have been granted
privileged write access (AccessRight.PRIVILEGED_WRITE
) can set this property
on a document while it is being checked in. Note that although the settability of this property
for users with privileged write access is SETTABLE_ONLY_BEFORE_CHECKIN
,
those users can not set this property on a document prior to check in; it can be set only
while a document is being checked in.
See Also
ContentTransfer
object) associated
with this document or annotation was last accessed. The Content Engine stores dates and times using
Coordinated Universal Time (UTC). The recording granularity of the date and time returned by this property is
determined by the setting of the object store's ContentAccessRecordingLevel property. The content data
associated with a document or annotation object is considered to be accessed when one of the following events occur:
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.See Also
Settability of this property is read-only for most users. For users who have been
granted privileged write access (AccessRight.PRIVILEGED_WRITE
), this property is
settable only on create. After initial object creation, this property is read-only for all users.
See Also
Settability of this property is read-only for most users. For users who have been granted privileged
write access (AccessRight.PRIVILEGED_WRITE
), this property is read/write. (The read/write access for those
users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that
object store).
See Also
See Also
See Also
See Also
See Also
See Also
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 owner can check in,
modify, or delete.See Also
FixedStorageArea
objects only.)See Also
RetentionPeriod
property is set to -2).
Normally the provider will examine the value of the FP_RETENTION pool capability and explicitly set the retention
period to either zero or infinite, depending on the capability setting. When DefaultRetentionPassThrough is set
to 1, the retention period is set to RETENTION_PERIOD_DEFAULT (meaning that the Clips use the current Centera
system setting, which can be altered by changing the compliance mode of the system).
See Also
Site
class
that holds the Virtual Server (and thus, Server Instance) of the current application server instance.
A user with system administrator rights can subsequently assign a different site to be the default, if desired.
If you do not specify a site when creating a site-related object (such as an ObjectStore
object),
the created object's Site
property is set to the value of the DefaultSite
property.
See Also
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. See Also
See Also
DocumentSet
collection object that contains all of the publication documents to which
this document is the owner document.
See Also
DequeueHost
value for each retry,
depending on which server actually processed the queue item.
See Also
See Also
The text is not locale-specific to the retrieving user except for the following classes:
See Also
LocalizedStringList
object containing a collection of LocalizedString
objects, each of which
represents a locale-specific, user-readable description of a class or property.
See Also
SourceDocument
property.
See Also
See Also
See Also
See Also
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, IBM Tivoli, Novell eDirectory, and SunOne) that will be queried by the Content Engine
server when authorizing user and group names for login.
See Also
See Also
set_DirectoryServerPassword
, passing in an
encrypted byte array. (See the Encryption.encrypt
methods for information on
encrypting the input.) Security measures prevent actual passwords from being returned, so
a call to get_DirectoryServerPassword()
returns a zero-length byte array
instead, giving an indication that the property value has been set. If the password has not been set,
the value returned by get_DirectoryServerPassword()
is null
.
See Also
See Also
See Also
See Also
See Also
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.
See Also
true
, the dispatcher runs. When false
,
the dispatcher does not run.
For the CFSImportAgentConfiguration
interface, when the value
of this property is true
, the dispatcher runs, but the importer as a
whole might still not process import requests when the import agent sub-component has not
also been enabled. For more information, see the
IsImportAgentEnabled
property on the
CFSSiteSettings
interface. For a discussion of the importer
sub-components, see the
CFSImportAgentConfiguration
interface.
See Also
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
For the CFSImportAgentConfiguration
interface, this
property, despite the name, applies to the importer sub-component known as
the import agent and not to the import dispatcher; for information on the
importer sub-components, see the
CFSImportAgentConfiguration
interface.
See Also
See Also
LocalizedStringList
object containing a collection of LocalizedString
objects, each of which represents a locale-specific, user-readable display name for a
class definition, property template, or choice.
See Also
The name that uniquely identifies a given group or user. The distinguished name (DN) consists of a group or user's short name and the name of the domain to which it belongs. For example, for a group with the short name "Managers", the distinguished name might be "CN=Managers,DC=example,DC=com".
See Also
DocumentClassificationActionSet
object that contains the collection of DocumentClassificationAction
objects that have been created in this object store. Each DocumentClassificationAction
object
represents Java™ code for auto-classifying documents that hold a particular type of content data.
See Also
DocumentLifecycleAction
object associated with this DocumentLifecyclePolicy
object
that holds the definition of the actions to take when a document's lifecycle state changes.
See Also
DocumentLifecycleActionSet
object that contains the collection of DocumentLifecycleAction
objects defined in this object store.
See Also
DocumentLifecyclePolicySet
object that contains the collection of DocumentLifecyclePolicy
objects associated with this object store or DocumentLifecycleAction
object.
See Also
DocumentLifecyclePolicy
object that represents the lifecycle policy that has been applied
to this document. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the
transition of those states, and specifies the actions to be taken when a document's lifecycle state changes.
See Also
DocumentStateList
object that contains the complete set of valid document states
(each of which is represented by a DocumentState
object) defined by this DocumentLifecyclePolicy
object.
Each document lifecycle policy defines a set of states through which a document can transition into during its lifecycle.
See Also
See Also
See Also
See Also
See Also
See Also
See Also
See Also
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://10.15.14.28:7001/FileNet/Engine"
"iiop://localhost:2809/FileNet/Engine"
"Jnp://localhost:1099/FileNet/Engine"
The maximum length of the URI string is 2083 characters.
See Also
See Also
This property can be accessed from a ContentElement
-based object,
or from GetContentEvent
, representing the event fired when the
content element specified in this property is retrieved.
See Also
User.get_Email()
.
See Also
See Also
true
) or not (false
).
See Also
Domain
object's public key. The value of this property
specifies how to perform the encryption operation using the retrieved key, and takes the form of a
Java™ Cryptography Extension (JCE) transform string, for example, RSA/NONE/PKCS1PADDING
.
See Also
See Also
See Also
See Also
See Also
Subscription
-based object (ClassSubscription
, ClassWorkflowSubscription
, InstanceSubscription
, InstanceWorkflowSubscription
).
You set the property with an EventAction
object,
which must already exist in the object store. You then specify the property when you create
the Subscription
-based object.
Once this property is set, the Content Engine adds the Subscription
-based object to the
EventAction
object's Subscriptions
collection property.
See Also
EventAction
objects associated with an ObjectStore
object.
See Also
See Also
Event
object that triggered the queued event action.
See Also
For a custom event, this property can be set by a client application to convey state to the event action handler. Therefore, it is up to the client application and event action handler to define and interpret the value of this property. In the event action handler, this property can be retrieved from the event object passed to the handler.
Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.
See Also
See Also
See Also
ExternalPropertyAliasList
collection of the external aliases defined for this
property definition or replicable class definition.
See Also
ExternalClassDescriptionSet
object containing the set collection of ExternalClassDescription
objects associated with this external repository.
See Also
See Also
ExternalPropertyDescriptionSet
object containing the set collection of ExternalPropertyDescription
objects associated with this external class description.
See Also
ExternalIdentityList
collection of the ExternalIdentity
objects representing the
identities of replicas of this object in external repositories.
See Also
ExternalRepositorySet
object containing the set collection of ExternalRepository
objects
associated with this domain.
See Also
See Also
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.See Also
See Also
See Also
BlobWriteCollisionAvoidanceFlag
is used in tag
write and only applies to blobs.)
See Also
See Also
See Also
FPClip.Delete
and FPClip.AuditedDelete
) and
the deprecated purge operations (FPClip.Purge
and FPTag.BlobPurge
). Possible values are:
See Also
FPClip.Exists
and FPTag.BlobExists
).
Possible values are:
See Also
FPPoolQuery.Open
).
Possible values are:
See Also
FPClip.Open
, FPTag.BlobRead
,
and FPTag.BlobReadPartial
). Possible values are:
See Also
FPClip.Write
and FPTag.BlobWrite
).
Possible values are:
See Also
See Also
See Also
See Also
See Also
See Also
See Also
See Also
See Also
For a related JNDI name, see the FederationJNDIXADataSource property. For information on specifying the external repository, see the SourceRepositoryName property.
See Also
For a related JNDI name, see the FederationJNDIDataSource property. For information on specifying the external repository, see the SourceRepositoryName property.
See Also
true
, the external document changes have
priority, and CFS unconditionally updates FileNet P8 documents with the imported metadata.
When false
, CFS updates a FileNet P8 document only if the document has not been changed
more recently than the corresponding external document.
Suppose, for example, that a FileNet P8 document X exists with a corresponding external document
Y, a user within the FileNet P8 repository has changed the metadata for X yesterday, a user within the
external repository has changed the metadata for Y the day before yesterday, and CFS, as
scheduled, imports metadata today from the external repository into the FileNet P8 repository.
CFS discovers that X has been changed more recently than Y, and therefore does not update
X with the metadata from Y (presuming that the FederationUpdateHasPriority property has a value of false
).
CFS performs the change date comparison based on the FileNet P8 DateLastModified property and the corresponding property on the external document. If the external document has no such corresponding property, CFS unconditionally updates FileNet P8 documents with imported metadata regardless of the value of this property.
See Also
For a StoragePolicy
object, FilterExpression
is used as the selection criteria
for determining into which storage area the content for a document or annotation should be stored. The
expression is evaluated against all storage areas to determine which ones are deemed "equivalent" in
terms of this storage policy.
For a Subscription
-based object, FilterExpression
is used to determine
whether the event action should be launched.
The filter is applied to either the source object, or optionally to the object specified by the
Subscription
-based object's FilteredPropertyId
property.
Note that for version series subscriptions,
the filter is applied to the document version in the transaction and not to the version series.
The filter evaluation occurs as part of processing an event's subscriptions. The Content Engine server evaluates the filter expression, as follows:
true
, the event specified by the subscription is fired
or enqueued, as appropriate (depending on whether the event code 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 is silently discarded.Note If, in a document subscription that specifiesPublishRequestEvent
as a subscribed event,
you want to apply a filter expression to the document being published, you must set the subscription's FilteredPropertyId
property
to the PublishRequest
object's InputDocument
property.
(When you publish a document, a PublishRequest
object is created, which, at runtime, is the object that triggers PublishRequestEvent
,
not the document being published.)
For both a StoragePolicy
object and a Subscription
-based object,
the syntax of this property must be a fragment of a SQL where
-clause expression
(for example, VersionStatus = 1
) and use supported operators. Note that some operators
that are valid in a Content Engine query are not supported.
The following operators are not supported.
See SQL Syntax Reference.
Note that a filter expression can include conditions expressed against non-queryable and non-persistent properties. For example, the following is a valid expression: Owner='jsmith'
A filter expression using the IsClass operator must be constructed in the following fashion (not case-sensitive): IsClass(Source,<Class_id>). Class_id can be either a symbolic name or a GUID.
In a filter expression using the IN operator, the following conditions apply:
See Also
FilterExpression
property).
For example, an event on a ReferentialContainmentRelationship
can specify Head
in the FilterPropertyId
property to have the containable object -- rather than the ReferentialContainmentRelationship
-- used for filtering.
The use of a filter expression is optional. If FilterPropertyId
is null, the source object itself
is evaluated by the filter expression.
Note If, in a document subscription that specifiesPublishRequestEvent
as a subscribed event,
you want to apply a filter expression to the document being published, you must set this property
to the PublishRequest
object's InputDocument
property.
(When you publish a document, a PublishRequest
object is created, which, at runtime, is the object that triggers PublishRequestEvent
,
not the document being published.)
See Also
FixedStorageArea
object.
See Also
See Also
See Also
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.
See Also
See Also
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.
See Also
* \ / : * ? " %lt; > |
See Also
FolderSet
collection object containing the Folder
objects in which this document is filed.
See Also
See Also
UpgradeAddOn
object.
The list must contain one or more IDs (and will usually contain only one).
See Also
FULLTEXTROWLIMIT
option for a SQL statement. As this value is increased, the amount of system resources
used in a full text search operation goes up, as does the time to execute a full text search that results in a large number of hits. As
this value is decreased, the accuracy of full text searches may be reduced.
See Also
FULLTEXTROWLIMIT
option is specified for a SQL statement, the lesser of this property value and the value
specified for FULLTEXTROWLIMIT
is used as the maximum number of rows that can be returned.
This limit prevents excessive resource use during a search operation.
See Also
Multiple server configurations might require a more frequent cache update polling interval (that is, a smaller TTL value) if GCD updates are a normal occurrence. However, since objects residing in the GCD are designed to be static in nature, updates to GCDCacheTTL are unlikely.
See Also
See Also
See Also
See Also
See Also
See Also
The default value of this property is null for Active Directory service provider. The default value for other supported directory service providers is unique to the provider, as follows:
See Also
samAccountName
for the Active Directory service
provider and cn
for all other supported directory service providers.
See Also
(&(objectClass=user_defined_class)(an_attribute={0}))
, where
user_defined_class is the object class you want (for example, user) and an_attribute
is the LDAP server-specific attribute (for example, samAccountName, cn, or uid).
The default value of this property is unique to the directory service provider, as follows:
See Also
See Also
See Also
Group
objects belonging to a given realm or group.
See Also
See Also
See Also
See Also
For a DynamicReferentialContainmentRelationship
object, the head is always a Versionable
object
representing the current document version.
For a ReferentialContainmentRelationship
object, the head can be any of the Containable
subclasses
(such as a CustomObject
, Document
, or Folder
object). In this case, when the head is a
Document
object, it represents a specific document version.
For a Link
object, this property can specify any object that is a subclass of the
IndependentObject
base class.
See Also
See Also
See Also
ISDomainName
and ISOrganization
properties.
See Also
ISDomainName
and ISOrganization
properties.
In most cases, this value will be "FileNet".
See Also
See Also
See Also
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.
See Also
IdList
object containing the collection of all of the IDs used to identify this
class description or property description. The collection includes the value of this class description
or property description's Id property and the values of any assigned alias IDs.
See Also
ImageServicesClassDescriptionList
object, which contains a collection of the Image Services document class descriptions associated
with this FileNet Image Services fixed content device.
See Also
See Also
See Also
ImageServicesPropertyDescriptionList
object containing an ordered collection of all of the Image Services (IS) property descriptions
belonging to this IS document class description. This property contains the IS properties associated with an existing IS document class on the
IS server and is used by the IS Import Agent to map IS document properties to Content Engine properties when importing federated documents.
See Also
See Also
ClassDefinitionSet
object, which contains a
ClassDefinition
object for each class that is an immediate
subclass of the class defined by this ClassDefinition
object.
See Also
ClassDescriptionSet
object, which contains a
ClassDescription
object for each class that is an immediate
subclass of the class described by this ClassDescription
object.
See Also
com.filenet.engine.content.fcprovider.centera.CenteraFCP
com.filenet.engine.content.fcprovider.is.ImageServicesFCP
com.filenet.engine.content.fcprovider.fsb.SnaplockFCP
See Also
See Also
See Also
See Also
See Also
See Also
See Also
See Also
IndexArea
object containing the Verity collection referenced by the IndexationId
property.
See Also
IndexArea
objects that can be used to store full-text indexing information for this object store.
See Also
IndexJobItem
.
See Also
null
for objects that were full text indexed prior to
the 4.0 release.
This property must be set if the property is to be CBR enabled (the PropertyDefinitionString.IsCBREnabled
property).
See Also
See Also
See Also
This property is available for asynchronous events only. For synchronous events, get the current user from the server context.
See Also
See Also
See Also
See Also
See Also
null
.
See Also
See Also
See Also
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.
See Also
true
) or not (false
). The current version can be a major version or a minor version.
See Also
EventAction
object's IsEnabled
property to false
(off) or true
(on).
Likewise, you can enable or disable a subscription or a security template. Enabling a security template indicates
that it can be applied to an object. A disabled security template remains
part of its security policy container, but cannot be applied to an object. Disabling a security template is useful
when you are testing or developing the security templates that make up a security policy. Disabling a subscription
prevents the function associated with the event from being loaded and executed. You might want to disable a subscription that is
undergoing modifications due to a change in business processes or when you do not want functions to execute against
federated documents. Note that when you disable an EventAction
, all of its associated subscriptions are also
disabled. However, when you disable one particular Subscription
, you only disable events that are in its subscribed event list.
See Also
true
) or not (false
).
If a document version is frozen, you cannot modify its custom properties. However, you may be
able to modify the custom properties of other versions of that document, provided they have not been frozen.
Note that the modifiability of a document's system properties is not affected by a document version's frozen status.
See Also
true
)
or not (false
).
See Also
A non-hierarchical marking set contains one or
more markings, each independent of all others. A hierarchical marking set has an order of precedence to its
markings determined by their order in the set. Its markings are arranged in
a simple, single branch hierarchy. This order of precedence is followed when evaluating access
rights. Each marking has a superior marking (which must be in the same set),
except for the top marking (its superior is null
). A marking in a hierarchical marking set
explicitly grants access rights to a set of security principals. It also implicitly grants the same rights
for all markings that are inferior to it in the hierarchy.
See Also
false
, the agent does not run. When
true
, the agent runs, but the importer as a whole might still not
process import requests when the dispatcher sub-component has not also been enabled. For more
information, see the
DispatcherEnabled
property on the CFSImportAgentConfiguration
interface.
For a discussion of the importer sub-components, see the
CFSImportAgentConfiguration
interface.
See Also
true
) or not (false
).
As long as a document is in an exception state, its lifecycle state can neither be promoted nor demoted.
To clear a document from an exception state, you must call its changeState
method and set the
LifecycleChangeFlags
parameter to CLEAR_EXCEPTION
.
See Also
true
) or not (false
). An object that has a designated name property (the IsNameProperty property
of one of its properties is set or the NamePropertyIndex property of the object's class description is set)
will have the designated name property's value assigned to its Name property. An object can have only one
designated name property.
See Also
See Also
true
) or not (false
).
If this property is false
, only the server can save the state of the object.
See Also
true
)
or not (false
). If IsReadOnly
is true
, the property's value can only be changed by the server.
See Also
Document
object, specifies whether a user has reserved the right to check in the next version following
this version (true
) or not (false
). For a VersionSeries
object, specifies whether the
current version in this version series is checked out (true
) or not (false
).
See Also
DirectoryConfiguration
object.
The default value for all directory server types supported by the FileNet P8 Content Engine is
false
, indicating that SSL is disabled.
See Also
See Also
Unlike a dependently securable object, which inherits its security from a parent object, an independently securable
object has its own Access Control List (ACL) that specifies its security and
ensures that access rights are checked each time a user tries to access the object. As an example, a Document
object is the security parent of its dependent ContentElement
objects. The value of this
property is true
if the given object's security is independently settable (as in the case of Document
) and is false
if the
object's security is inherited from a security parent (as in the case of a ContentElement
).
See Also
See Also
See Also
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 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 may be a delay if there are many other asynchronous events or operations (such as security propagation or XML classification) 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 the Content Engine.
See Also
IsSystemGenerated
is true, the
described property either provides system information (for example, DateCreated
) or has its
value determined by the server according to the results of a method call or some other operation
(for example, if you call a folder's CreateSubFolder
method, the system will automatically
add the newly created folder to the collection of objects returned by the SubFolders
property).
See Also
See Also
See Also
true
) or not (false
).
See Also
See Also
See Also
IsolatedRegionSet
object containing the list of isolated regions (IsolatedRegion
instances) available
in this P8 domain.
See Also
See Also
See Also
See Also
See Also
DYNAMIC_LABEL_CR
.
For all other component relationship types the value of this property is null
. For more information,
see ComponentRelationshipType Property.
See Also
See Also
Settability of this property is read-only for most users. For users who have been granted privileged
write access (AccessRight.PRIVILEGED_WRITE
), this property is read/write. (The read/write access for those
users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that
object store).
See Also
The maximum interval, in seconds, allowed a worker to process a batch before the assignment of the batch to another worker. This interval ensures that any abnormal termination of the worker previously assigned to the batch does not prevent batch completion.
See Also
See Also
See Also
UserContext
locale-specific operations as well as the WSDL-defined locale for the web
services SOAP transport.
See Also
See Also
See Also
See Also
See Also
See Also
lock
method.
The value of this property is simply a custom string that has no real effect in determining the user of the lock.
The owner specified by this property is not validated against any user or group known to the Content Engine.
This property is set to null
if the unlock
method is called; if the lock expires naturally,
then the value remains unchanged.
See Also
lock
method; however, the value can be updated by a call to updateLock
.
The property value is the number of seconds beyond the value in the object's DateLastModified property that
the user of the lock can hold the lock on the object. The result of the calculation is measured against the current
system time. The lock is considered expired when the value of the object's DateLastModified property
plus the value of the LockTimeout property is less than the current system time. (All millisecond
components are dropped from the calculation.) This property is set to null
if the unlock
method is called; if the lock expires naturally, then the value remains unchanged.
See Also
unlock
), the value of LockToken
is set to null
.
(If the lock expires naturally, then the value remains unchanged.)
See Also
See Also
See Also
get_Marking()
on a given ActiveMarking
object returns this object-valued property.
See Also
MarkingSet
is a container that holds all of the
possible values for a particular marking-enabled property. Each Marking
object in the marking set
represents a different value for the property.
You can retrieve a string-valued property's marking set by calling get_MarkingSet()
method on the
PropertyDefinitionString
, PropertyTemplateString
, or
PropertyDescriptionString
interfaces.
See Also
See Also
See Also
MarkingSet
objects.
See Also
The primary use of this MarkingUseGranted
property
is to detect whether the current user has the "Use" right.
The "Use" right determines whether the presence of the marking on an object constrains access to
that object. If the user has "Use" right to the marking, access to associated independent objects will not be constrained
by the value of the ConstraintMask
property on the Marking
object.
The absence of the "Use" right means that the values in the ConstraintMask
property will be subtracted from the
associated object's effective access calculation (which is the value returned by the
IndependentlyPersistableObject.getAccessAllowed()
method). In this case, the constraint mask
of the marking identifies which rights cannot be granted, and will be ignored, which effectively removes those rights
granted on the associated independent object's ACL.
See Also
Marking
to an object that has a property
associated with a MarkingSet
. This value of a marking must be unique within a marking set.
See Also
MarkingList
object, which contains a collection of Marking
objects.
See Also
See Also
IndexArea.ResourceStatus
property to "closed", and for this same site and object store, changes
to "open" the ResourceStatus
value of the first index area found having a ResourceStatus
value of
"standby".
See Also
One in-memory state cache exists per server. The state cache contains state information on content elements in the primary content cache area for a server, and can potentially improve the performance of a server by reducing the number of disk accesses the server must make to retrieve state information. For example, by storing the create date/time for a cache content element, the server can determine whether other previously retrieved information remains valid (thereby possibly avoiding the need to re-retrieve information for the content element).
See Also
This value, in combination with the MaxWorkerThreads parameter, establishes a threshold that, when exceeded, prevents additional batches of federation requests from being inserted in the in-memory pre-fetch queue. The number of items in the queue is reduced as batches of work are dispatched to worker threads. The number of batches in the queue will eventually fall below the threshold and the addition of new batches from the database queue will be resumed.
See Also
See Also
See Also
See Also
See Also
Setting this value helps to prevent excessive server resource usage by a single user.
See Also
See Also
See Also
For information on the CFS import agent, see the
CFSImportAgentConfiguration
interface.
See Also
For a content cache area, new content can be added to a cache only if the number-of-content-elements statistic (the ContentElementCount property) is less than this maximum. (This maximum might be slightly exceeded, as statistics are managed on a delayed basis, and multiple servers can be adding content.) The value for this property must be greater than or equal to 1.
See Also
See Also
See Also
See Also
For a content cache area, new content can be added to a cache only if the size-of-content-elements statistic (the ContentElementKBytes property) is less than this maximum. (This maximum might be slightly exceeded, as statistics are managed on a delayed basis, and multiple servers can be adding content.) The value for this property must be greater than or equal to 1.
See Also
A periodic prune occurs at maximum-time-to-live half-intervals. For example, if the specified maximum-time-to-live is two weeks, a periodic prune occurs once a week. The purpose of this prune is to ensure that expired files get deleted on a timely basis. A periodic prune is always a full prune. For a definition of full prune and a detailed discussion of pruning, see the PruneAmount property.
See Also
See Also
Use of this property can assist you in preventing excessive memory usage on the Content Engine server. When a merged scope cache is created and the class descriptions are loaded in the cache, the names of the classes are mapped to the first instance of the class encountered in the ordering sequence of the object stores to be merged. As an example, let's say that a class in object store A is named X and has the same GUID as a class named Y in object store B. If you merge object stores A and B, the class name of the merged scope cache (A,B) will be X, whereas the class name of the merged scope cache (B,A) will be Y. As you can see from this example, specifying many different orders of merged object stores could result in an excessive number of merged scope caches being created, and can exceed the server's memory capacity. Set the value of this property to limit the number of metadata merged scope caches that can reside in memory.
See Also
See Also
For Document
objects, you can set the MimeType property for a specific document
version while it is a reservation object (at creation time and on subsequent check-outs). However,
every time you check in a document, its MimeType property value reverts to its system-assigned
value unless you explicitly set it again.
For Annotation
objects, you can set this property at any time.
For DocumentClassificationAction
objects, the MimeType property specifies
the type of content that a document must hold in order to allow it to be auto-classified; you can
set this property at any time.
Each content element that is attached to a document or annotation has its own MIME type, which is specified by its ContentType property. If you do not specify the MimeType property for a document or annotation, it is automatically determined by the Content Engine according to the setting of each content element's ContentType property and the following logic:
ContentTransfer
objects that all have the same value for their
ContentType property, MimeType is set to the value of the ContentType property.ContentReference
object, MimeType is set to
"application/x-filenet-external".
ContentReference
objects (but no ContentTransfer
objects), MimeType is set to "multipart/x-filenet-external".MIME is a communications protocol that allows for the transmission of data in many forms, such as audio, binary, or video. A MIME format string consists of a content type, a content subtype, and an optional parameter in the following format: "MIME::content type/subtype[;parameter]". For example: "MIME::text/html". MIME defines the following content types:
The following MIME types are specific to FileNet:
ContentReference
content element.ContentReference
content elements only.See Also
See Also
See Also
AccessRight
and AccessLevel
classes 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.See Also
fetchInstance
method.
This property is not available from the event object passed to the
event action handler.
See Also
See Also
For most classes, this property is read-only and returns the value of the designated name property for the object,
or its ID if there is no name property. If ClassDescription.NamePropertyIndex
has a value,
this property contains the value of the designated name property. If there is no designated name property value, and
the object has an Id property, this property contains the string value of the Id property. If neither of these conditions
is satisfied, this property contains an empty string.
For a ComponentRelationship
object, this property is read/write and specifies the name of the object.
See Also
PropertyDescription
object in this ClassDescription
object's PropertyDescriptions
collection that serves as the name property for object instances
of the class (usually resolves to the DisplayName
property). If NamePropertyIndex
is
null
, the class will not have a designated name property; in this case, the Name property of the
object instantiation of the class will be set to the value of its Id property.
See Also
CenteraFixedContentDevice
object prevents the deletion of Clips
or Blobs on the Centera device (true) or not (false). If true, the provider never attempts to delete
Clips or Blobs and all content is left completely intact on the Centera device. Note that normally this
setting has no impact on enforcement of the retention period (the storage area honors the retention
period and prevents deletion when appropriate).
See Also
null
.
See Also
See Also
See Also
See Also
For more information about this cache, see Security Caching.
See Also
For more information about this cache, see Security Caching.
See Also
ORIGINAL_AND_MODIFIED_OBJECTS
(both the original, pre-event object and the modified,
post-event object are recorded), MODIFIED_OBJECT
(only the modified, post-event object is recorded),
and NONE
(no source objects are recorded).
If MODIFIED_OBJECT
is set, the event's OriginalObject property will be null.
If NONE
is specified, the event's OriginalObject and SourceObject properties will be null, and the event's
ModifiedProperties property will be empty.
Note: Persisting audited source objects in a database can result in substantial consumption of large object (LOB) storage.
See Also
See Also
See Also
You can customize the supplied default schema script and then submit your
customized script when you call the Factory.ObjectStore.createInstance(domain, admins, users, schemaScript)
method.
Typical modifications to the default script include the distribution of the various tables,
indexes, and Large Object (LOB) columns across different tablespaces. For more information,
see "Working with Object Stores" in the Content Engine Java and .NET API Developer's Guide.
See Also
You can customize the supplied default schema script and then submit your
customized script when you call the Factory.ObjectStore.createInstance(domain, admins, users, schemaScript)
method.
Typical modifications to the default script include the distribution of the various tables,
indexes, and Large Object (LOB) columns across different tablespaces. For more information,
see "Working with Object Stores" in the Content Engine Java and .NET API Developer's Guide.
See Also
You can customize the supplied default schema script and then submit your
customized script when you call the Factory.ObjectStore.createInstance(domain, admins, users, schemaScript)
method.
Typical modifications to the default script include the distribution of the various tables,
indexes, and Large Object (LOB) columns across different tablespaces. For more information,
see "Working with Object Stores" in the Content Engine Java and .NET API Developer's Guide.
See Also
ObjectStore
objects associated with a given FileNet P8 domain.
See Also
See Also
get_SourceObject
.
To compare the two states of the source object,
fetch the properties of the object returned by get_OriginalObject
and get_SourceObject
.
See Also
For objects indexed in this collection, an arithmetic function is performed on the object's GUID to map it to an ordinal number, indicating this ordinal number (the collection in which the object resides).
See Also
See Also
See Also
See Also
See Also
See Also
See Also
AppenderNames
property value
is the FileAppender
class or a subclass. If unspecified or null, this property value defaults to the application
server instance's working directory path appended with "/FileNet". The filename for the trace log is always
"p8_server_trace.log", and the log4j layout pattern used is "%d %5p [%t] - %m%n".
Note: Because log4j creates directories on the fly, the only validation against a non-null value for this property is that the location resides within a valid directory.
See Also
See Also
Document
object representing the
owner document associated with the published document. If this document is a publication and there
is a cascade delete relationship with the source, then this property will specify the publication
source document (the OwnerDocument
and PublicationSource
properties
will reference the same document).
See Also
See Also
See Also
PEConnectionPointSet
object containing the list of connection points (PEConnectionPoint
instances) available
in this P8 domain.
See Also
Folder
object for the folder that directly contains this folder.
See Also
Document
object designated as the parent in a component relationship. The setting for
the CompoundDocumentState property on this parent Document
object must be
COMPOUND_DOCUMENT
. Also, you must have link rights (AccessRight.LINK
) on the document.
See Also
DocumentSet
collection object that contains the parent Document
objects
bound to this child document. The collection contains only those parent documents for which the user has read
access. For each ComponentRelationship
object that references this document as the
child component document, the collection contains the parent component document. The same parent document
can be in the collection more than once.
See Also
ComponentRelationshipSet
collection object that contains the ComponentRelationship
objects referencing this document as the child component document. The collection contains only those
parent relationship objects for which the user has read access.
See Also
See Also
See Also
See Also
See Also
The source of access rights can be:
See Also
Valid types are single (that is, a single access right), level (a commonly used combination of access rights), default level (that is, the recommended level for new permissions), and inherited (relevant only to child objects of the parent object described by the permission).
See Also
See Also
PropertyPersistence
constant that indicates whether a property can be
made persistent (that is, have its state stored in a database). If a property can be made persistent,
it must have either a dedicated column or a dedicated table in the database.
The PropertyPersistenceType property can have one of the values in the following table.
Name | Value | Description |
---|---|---|
NOT_PERSISTENT |
0 | Specifies that a property cannot be made persistent. If a property is defined as NOT_PERSISTENT ,
has a default value defined, and the Settability property of its property template has a value of PropertySettability.READ_ONLY ,
the property is considered to be a constant and will always return its default value for any instance of the property that is returned. |
OWN_COLUMN |
1 | Specifies that the property has a dedicated column in the database and therefore can be made persistent. |
OWN_TABLE |
1 | Specifies that the property has a dedicated table in the database and therefore can be made persistent. This setting applies only to multi-valued scalar (non-object) properties and causes the server to store a property's values into a custom table, which is generated by the server when its property template is first assigned to a class definition as a property definition. The name of this table is derived from the name of the corresponding property. Once it has been created, the same table will be used to store the property's values, regardless of the class to which the property is assigned. |
See Also
FPPool
class constructor as the
PoolAddress parameter (which identifies the location of the Centera fixed content device). This pool
address will be used when the Content Engine server is running within the site identified by the Site
property of this object.
See Also
OPEN
, cache capacity has not been exceeded, etc.), content
newly added to the main storage area also gets added to the cache area.
See Also
See Also
false
, the object's original direct permissions
are replaced by the permissions defined by the applied security policy template or lifecycle policy. Permissions inherited from the object's security parent are retained.
If the value is true
, the object's original direct permissions are preserved as well as its inherited permissions.
See Also
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()
.See Also
For more information about this cache, see Security Caching.
See Also
For more information about this cache, see Security Caching.
See Also
See Also
PropertySettability
constant, which indicates the settability of a property when an application has
been granted privileged write access (AccessRight.PRIVILEGED_WRITE
access right). Privileged write access
gives an application the potential capability to set the Creator, DateCreated, DateLastModified,
and LastModifier properties, which are normally read-only. The Settability property continues to indicate the property's
settability for all other users.
The PrivilegedSettability property can have one of the values in the following table.
Name | Value | Description |
---|---|---|
READ_ONLY |
3 | Indicates that a property is read-only; only the server can set its value. |
READ_WRITE |
0 | Indicates that a property is read/write; you can set its value at any time. |
SETTABLE_ONLY_BEFORE_CHECKIN |
1 | Indicates that you can only set the value of a property before you check in the object to which it belongs. |
SETTABLE_ONLY_ON_CREATE |
2 | Indicates that you can only set the value of a property when you create the object to which it belongs. Once you save the object for the first time, the property's value cannot be changed. |
See Also
See Also
PropertyDescriptionList
object containing a collection of the property description
objects belonging to all of the subclasses of the class described by this ClassDescription
object.
See Also
See Also
See Also
See Also
See Also
See Also
See Also
See Also
See Also
PropertyDefinitionList
object containing an ordered collection of all of the
property definitions belonging to this class definition.
See Also
PropertyDescriptionList
object containing an ordered collection of all of the
property descriptions belonging to this class description.
See Also
See Also
get_PropertyDisplayName
on the ActiveMarking
interface
to retrieve the value of this property. The returned value corresponds to the display name of the property that is designated as a marking property
for a given object. As an example, if a Document
object has a property named "foo" and that property is identified as a
marking property, then the list of active marking instances for the document will have a property
display name that corresponds to the display name of the "foo" property.
See Also
For ExternalPropertyDescription
objects only, this string is immutable and is unique within
the external class to which the external property description belongs.
See Also
See Also
See Also
See Also
See Also
See Also
See Also
See Also
BinaryList
object that contains the list of binary values that can be assigned to the
property described by this PropertyDescriptionBinary
object.
See Also
BooleanList
object that contains the list of Boolean values that can be assigned to the
property described by this PropertyDescriptionBoolean
object.
See Also
DateTimeList
object that contains the list of DateTime values that can be assigned to the
property described by this PropertyDescriptionDateTime
object.
See Also
Float64List
object that contains the list of Double (Float64) values that can be assigned to the
property described by this PropertyDescriptionFloat64
object.
See Also
IdList
object that contains the list of GUID string values that can be assigned to the
property described by this PropertyDescriptionId
object.
See Also
Integer32List
object that contains the list of integer values that can be assigned to the
property described by this PropertyDescriptionInteger32
object.
See Also
DependentObjectList
object that contains the set of Content Engine objects that can be assigned to the
property described by this PropertyDescriptionObject
object.
See Also
StringList
object that contains the list of string values that can be assigned to the
property described by this PropertyDescriptionString
object.
See Also
PropertyTemplate
subclass (PropertyTemplateBinary
,
for example) that specifies the property template on which this property definition is based.
See Also
PropertyTemplateSet
object that contains the defined property templates in this object store.
See Also
See Also
See Also
Specifically, a prune action begins by calculating two prune quotas: a number quota and a size quota. These quotas apply to each directory. The quota calculation takes into account the prune amount percentage (as specified by the PruneAmount property), the prune thresholds (as specified by the PruneThresholdContentElements and PruneThresholdSizeKBytes properties), the current amount of content in the cache (as indicated by the ContentElementCount and ContentElementKBytes properties), and the number of cache directories. Specifically:
For example, for the number quota, suppose when the prune action begins the cache contains 100,100 files, the prune threshold is 100,000 files, the prune percentage is 5%, and the cache has 529 directories. The prune target, in this case, is 95,000: 100,000 minus 5,000 (5% of 100,000). The quota for each directory equals 10: 100,100 minus 95,000, divided by 529 (rounded up). The size quota gets calculated in a similar manner.
A full prune action consists of two phases: an initial prune and a partial prune. An initial prune deletes all abandoned and expired files and also generates an LRU (least-recent-use) list for each directory. All files in the directory are put in ascending time-of-last-use order on this list; the first file listed has been accessed less recently than any other file (in other words, it is the oldest). A partial prune processes old files in LRU list order. As a file can be retrieved from the cache at any time--and thus might be younger than it was at LRU list generation time--a partial prune always checks the time-of-last-use for a file before deleting it. It skips any file with a time-of-last-use more recent than the LRU list creation time. The partial prune continues down the LRU list in this manner, taking files off the list as they are either deleted or skipped.
All old and expired files deleted in a directory count towards the quotas for that directory, although the quotas only control the number of old files deleted during the partial prune (as all expired files get deleted during the initial prune). Note that in a full prune the prune quotas might be satisfied during the initial prune phase. In this case, the second phase of the full prune--the partial prune--does not occur. Also, regardless of when the prune quotas might be satisfied during the course of the prune, an initial prune always generates a new LRU list.
For an overview of pruning and a discussion of the categories of files deleted during a prune, see the ContentCacheArea interface.
See Also
With respect to any given directory, a mandatory prune can be either a full or partial prune (and so, with respect to the cache as a whole, a mandatory prune can be a mixture of full and partial prunes). It is a full prune only when the LRU list needs to be generated. Specifically, it is a full prune in these circumstances: this is the first pruning action for a new cache, and consequently no LRU list yet exists; the LRU list has expired (it is older than 1 day); or a previous prune action exhausted the LRU list. (Note that a partial prune can exhaust the LRU list without satisfying the prune quotas.)
For an overview of cache pruning, see the ContentCacheArea interface. For definitions of pruning terms (full prune, partial prune, LRU list, etc.) and a detailed discussion of pruning, see the PruneAmount property.
Note that, as indicated above, the PruneThresholdSizeKBytes property defines another pruning threshold.
See Also
See Also
See Also
See Also
<publicationinfo>
<styletemplateid>{14917CF3-4D5F-499D-BA38-8E010199745E}</styletemplateid>
<publishtemplateid>{4D696690-EEBB-4341-9FE7-A8F715BAE96D}</publishtemplateid>
<pubtemplversionseriesid>{459A0D5A-5B44-4AD1-B15C-91D7B773B3DD}</pubtemplverseriesid>
<outputfolderid>{4EF26F2E-61D8-47FD-8201-EE81C3AA75FA}</outputfolderid>
</publicationinfo>
If the document is not a publication, the property is empty.
See Also
See Also
PublishStyleTemplate
object associated with this publish request.
See Also
PublishTemplate
object associated with this publish request.
If this property is set, the PublishRequest
object is for a publish operation. To
perform a republish operation, the PublicationDocument
property must be set and this
property must be null
.
See Also
See Also
See Also
See Also
Document
object that provided the content for the full-text search.
See Also
See Also
See Also
See Also
See Also
For the PublishingConfiguration
object, this property specifies the maximum
number of publish request handler instances.
See Also
For the PublishingConfiguration
object, the queue item is a publish request.
See Also
Subscription
object that caused a given asynchronous event to be queued.
For the
See Also
See Also
See Also
For example: given an object-valued property in class A, its reflective property is an object-valued property in class B whose required class is class A. In order for an object-valued property in objects instantiated from class A to return specific objects, you must set its reflective property in each object of class B that you wish it to return.
See Also
The region key is used to generate IBM FileNet P8 Identity Tokens for use between Process Engine applications and Process Engine servers. In the IBM FileNet P8 4.5 release, this key is generated by Content Engine, based on the RegionPassword property. In a future release, Process Engine will generate the isolated region key using the FIPS 140-2 compliant Advanced Encryption Standard (AES) algorithm. The key is then passed to the Content Engine and the value is stored on the Content Engine server in the GCD, encrypted with the Content Engine's master key.
Because the datatype is binary, you should set the RegionKey property value
through a secure channel (Secure Socket Layer, or SSL). If the value is set, retrieval of the region key returns a
zero-length value; otherwise, returns null
.
Note: Support for the isolated region key generation using a password will be discontinued in a future release.
See Also
Note that the region key is used to generate P8 Identity Tokens for use between Process Engine applications and Process Engine servers. The region password that is entered for an isolated region must exactly match the region password that is entered when creating or editing the isolated region through the Process Engine admin tools. If these two passwords (and the region keys that are generated from them) do not match exactly, then Process Engine authentication will fail.
The datatype is binary, because the password is encrypted before it goes across the wire.
See Also
RELEASED
.
Note that only one document version at a time in a given version series can be in the released state.
See Also
See Also
RenditionEngineConnection
object used by this publishing configuration.
See Also
RenditionEngineConnectionSet
object that lists the Rendition
Engine connections for this domain.
See Also
See Also
See Also
See Also
ReplicationGroup
object representing the replication group to
which this replicable object belongs.
See Also
See Also
See Also
See Also
See Also
See Also
See Also
ClassDescription
object describing the class or superclass of which an object returned by
the object-valued property described by this PropertyDescriptionObject
object must be an instance.
See Also
ClassDescription
object describing the class or superclass of
which an object returned by the object-valued property described by this PropertyDefinitionObject
object
must be an instance. Although there are no restrictions on the type of class that you can specify for a RequiredClassId property,
if you set it to a class that describes a dependent object, you will not be able to set the property described by this
PropertyDefinitionObject
object to that dependent object. This is because you cannot set a custom
object-valued property to a dependent object; unlike a system object-valued property, a custom object-valued property can
hold independent objects only.
See Also
See Also
RESERVATION
. A reservation object is created by the server when you check out a document,
which you can modify and check in as a new version of that document.
See Also
ReservationType
constant that explicitly indicates the type of this document reservation
(collaborative or exclusive) or whether its reservation type is the same as the default object store setting.
The ReservationType property can have one of the values in the following table.
Name | Value | Description |
---|---|---|
COLLABORATIVE |
16 | Indicates a collaborative reservation, which is a reservation that any user with the appropriate permissions can check in, modify, or delete. |
EXCLUSIVE |
32 | Indicates an exclusive reservation, which is a reservation that only the owner can check in, modify, or delete. |
OBJECT_STORE_DEFAULT |
0 | Indicates that the reservation type is the same as the default reservation type for the object store, which is specified by the DefaultReservationType property. |
See Also
true
) or not (false
). If the ResetLifecycleOnCheckin property of a document's
associated DocumentLifecyclePolicy
object is set to false
, the lifecycle state of the document will remain the same
from one version to the next unless you explicitly change it using the document's changeState
method.
See Also
ResourceStatus
object, which specifies the availability status
of a storage or index area. The status value can be any one of the following:
Note: When the ResourceStatus
value is UNAVAILABLE, the indexer creates a new
collection and completes any pending index requests using the new collection.
The Content Engine supports the following automatic transitions between status values:
An area's status can also be changed manually as allowed by the following rules:
See Also
For Image Services, this property allows you to specify the Image Services document class
name for content that is stored on an Image Services fixed content device. This value will
override the DefaultISDocumentClass property on the associated IMFixedContentDevice
object. For example:
x-filenetfsrs:?ISDocClassName=SomeDocClassName
See Also
By default (that is, when the property value is false
), the Content Engine
Server automatically traces cross-realm group membership (also called cross-domain group
membership in Active Directory). If it reaches a realm that is not configured in FileNet
Enterprise Manager, the Content Engine server returns a "Realm not found" error and
group membership search processing stops. However, if the property value is true
when
this situation occurs, the Content Engine server logs an informational message to the
Content Engine server error log and the group membership search continues.
Note: This property is not supported for the Windows Active Directory Application Mode (ADAM) directory service provider. This is because ADAM does not support cross-realm group memberships (cross-partition memberships, in ADAM terminology).
See Also
RetentionPeriod
class, are:
FixedStorageArea
objects only.)See Also
ContentTransfer
object) can be retrieved for editing. The complete path (including the file name) can contain up to
2083 characters; the file name itself can be up to 255 characters long.
See Also
See Also
See Also
true
, the service provider returns the names in
DN format, which is consistent with other types of directory service providers.
See Also
See Also
ClassDefinitionSet
object containing the set of root class definitions (objects instantiated from ClassDefinition
and its subclasses) that are defined in this object store. Each class definition defines the set of mutable metadata (including property definitions) for a given class.
Once you have set a reference to collection returned by the RootClassDefinitions
property, you can access all of the mutable class metadata
available in this object store.
See Also
The following information is specific to the use of VerityIndexArea.RootDirectoryPath
:
VerityIndexArea.TempDirectoryPath
is not null, the value for the this property
can be a local directory on the Verity server. See Also
Folder
object representing the root of the container hierarchy associated with this object store
See Also
See Also
Action
-based object's events are raised.
NOTE: For this release, scripting languages are not supported for event procedures. Text in the ScriptText property will be ignored.
See Also
See Also
false
. To enable cross-forest group membership searches, set this
property to true
.
See Also
See Also
VerityIndexArea.VeritySearchServers
property
that will be attached to a newly created collection. The servers chosen will be those with the fewest collections already attached to them.
See Also
See Also
See Also
Folder
object from which the object inherits security (a security parent).
This value is indirectly set when DefineSecurityParentage is specified as the value of the defineSecurityParentage
parameter for the Folder.file
method.
The value, in this case, is the folder in which the object is filed.
You can designate multiple security parents for an object by using one or more object-valued properties
and setting the SecurityProxyType
value for these properties to INHERITANCE
.
See Also
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.
See Also
SecurityPolicySet
object that contains a collection of the security policies
associated with this ObjectStore
object.
See Also
SecurityPolicy
associated with the given object. The SecurityPolicy
contains one or more SecurityTemplate
objects that define the permissions to assign to a given
object. A security template can be one of two types: a VersioningSecurityTemplate
or an
ApplicationSecurityTemplate
. A VersioningSecurityTemplate
defines permissions that will be
automatically assigned to the object when its version state changes. An ApplicationSecurityTemplate
defines permissions that will be assigned to the object upon an explicit call to do so by an application
program. For information on each of these types of templates, refer to their interface descriptions.
Assigning a security policy to a Document
, CustomObject
, or Folder
object
(or their subclasses) is optional.
See Also
This property specifies the manner in which setting a value for the described object-valued property establishes a security proxy
for the object. Valid values are FULL
and NONE
. For descriptions of each value,
see SecurityProxyType.
FULL
on one of its object-valued properties delegates
its access control authority to the object referenced by that property.FULL
.See Also
SecurityTemplateList
object that contains a collection of the security templates
associated with a given Security Policy
object.
See Also
See Also
ServerInstance
objects for a given virtual server.
See Also
PropertySettability
constant, which indicates when the value of a property can be set:
For special system property cases in which privileged write access may be granted, the PrivilegedSettability property
governs the property's settability for users who have AccessRight.PRIVILEGED_SETTABILITY
access,
while the Settability property continues to indicate the property's settability for all other users. See the description of the
PrivilegedSettability property for these special cases.
The Settability property can have one of the values in the following table.
Name | Value | Description |
---|---|---|
READ_ONLY |
3 | Indicates that a property is read-only; only the server can set its value. |
READ_WRITE |
0 | Indicates that a property is read/write; you can set its value at any time. |
SETTABLE_ONLY_BEFORE_CHECKIN |
1 | Indicates that you can only set the value of a property before you check in the object to which it belongs. |
SETTABLE_ONLY_ON_CREATE |
2 | Indicates that you can only set the value of a property when you create the object to which it belongs. Once you save the object for the first time, the property's value cannot be changed. |
See Also
An example of a user's short name is "test1", or a group's short name might be "Managers". The short name format does not require any other qualifying information, such as domain. See the
DistinguishedName property on the User
or Group
interface
to compare the short name format to the distinguished name (DN) format.
See Also
Document
, Folder
, Annotation
, or CustomObject
object to be indexed.
See Also
Site
property defaults to the value of Domain.DefaultSite
.
See Also
SiteSettings
objects associated with a fixed content device. Site settings provide
site-specific, configuration value overrides. For each fixed content device type with settings that can be
overridden, a corresponding subclass of SiteSettings
is defined with properties that, if populated,
will override the corresponding properties of the same name on the fixed content device object.
For an EMC Centera fixed content device, this property allows the PoolAddress property to be different, depending
on the site in which the Content Engine server is running. If the Content Engine server is running in a site
that does not correspond to one of the SiteSetting
objects, then the PoolAddress property on the
CenteraFixedContentDevice
object is used as the default.
For a FileNet Image Services fixed content device, this property allows the CSMCache property to be different
depending on the site in which the Content Engine server is running. If the Content Engine server is running
in a site that does not correspond to one of the SiteSetting
objects, then the CSMCache property
on the IMFixedContentDevice
object is used as the default.
For a NetApp SnapLock fixed content device, there are currently no properties that may be customized for a site.
See Also
Site
objects for this domain. Each element of the collection
represents a geographical area in the domain.
See Also
SnapLockUserName
property.
See Also
See Also
See Also
See Also
get_OriginalObject
on subclasses of ObjectChangeEvent
that provide this method.
See Also
ObjectChangeEvent
-based event.
You can use this property to identify an object if it no longer exists in the object store.
See Also
CFS requires and expects this external repository to have a document model compatible
with the FileNet P8 model. In particular, CFS requires that document content within an
external repository not change, and locks down documents, as necessary, to enforce this
requirement. (For an overview of the properties needed to implement a document lockdown,
see the
IICEFixedContentDevice
interface.)
In addition to this requirement, CFS and the Content Engine expect the version order
for a document to be unchanging. (If the external repository does not support document
versioning, CFS considers each version series to consist of one version.) The consequences
of violating this expectation by federating a version series with a non-immutable version
order include the following:
For more information on CFS document importing, see the
CFSImportAgentConfiguration
interface.
See Also
See Also
See Also
See Also
See Also
For a storage policy, this represents all storage areas (regardless of the ResourceStatus property value) that the policy references (the filter includes).
See Also
See Also
StoragePolicySet
object that contains a collection of storage policies
associated with an object store.
See Also
When a document is created, the order of precedence for setting the storage on the Document
instance is (from highest to lowest):
The default ClassDefinition for a document sets the StorageArea to "Database Storage Area" and the
StoragePolicy to "All Storage Areas". Therefore, if you create a new Document
instance
of the default Document
ClassDefinition with only the StoragePolicy property set, the
document will use the class default for the StorageArea property (Database Storage Area).
To avoid this situation, you must set the instance value for the document's StorageArea property
to null
. Because the instance value for StorageArea is set, but has no value, the
StoragePolicy property will be evaluated and used.
In general, storage policies should be used to allow administrators to properly administer their storage systems. They can assign multiple storage areas to be load balanced, and also assign standby storage areas to be used if any of the current storage areas become full.
See Also
PublishStyleTemplate
object associated with this publish
template. If this property is null
, then the publish template is for a copy operation;
otherwise, it's for a transformation operation. The PublishStyleTemplate
object's
OutputFormat
property will determine the type of transformation (for example, HTML or PDF).
See Also
FolderSet
collection object containing the Folder
objects for the directly-contained
child folders of this Folder
. Any referentially-contained child folders are not included in the collection.
See Also
See Also
See Also
Subject
elements are removed to allow more recently used elements to be cached.
See Also
See Also
SubscribedEventList
collection,
a list of objects representing the system and custom events to which to subscribe.
See Also
Subscription
-based object(ClassSubscription
,
ClassWorkflowSubscription
, InstanceSubscription
, InstanceWorkflowSubscription
).
You set the property with an a Subscribable
object, then specify the property when you create
the Subscription
-based object.
For a ClassSubscription
or ClassWorkflowSubscription
object, set the value of the
SubscriptionTarget
property to a SubscribableClassDefinition
object or subclass
that specifies a type of Content Engine class (for example, Document or Folder).
This means that any instance of the class, whether it
currently exists in the persistent store or you create a new instance, will, when acted upon, cause one or
more of the EventAction
object's events to be raised.
For an InstanceSubscription
or InstanceWorkflowSubscription
object,
set the value of the SubscriptionTarget
property
to a specific Subscribable object
. This means that only this currently instantiated object,
when acted upon, causes one or more of the EventAction
object's events to be raised.
If the object is a VersionSeries
object,
the event is raised when a version in the version series is acted upon.
See Also
See Also
See Also
ClassDefinition
object that defines the immediate superclass of the class defined
by this class definition.
See Also
ClassDescription
object that describes the immediate superclass of the class described
by this class description.
See Also
ExternalClassDescriptions
collection of the external repository.
See Also
See Also
AddOn
objects superseded by this AddOn
.
Although present on the AddOn
object and, by inheritance, the
UpgradeAddOn
object, this property has no use on the
UpgradeAddOn
object..
A newer version AddOn
must specify in this property the IDs of the
prior version AddOn
objects
that it functionally replaces, allowing an application with a dependency on that replaced
(superseded) functionality to determine whether the functionality is available through the
superseding AddOn
. (See also the isAddOnInstalled
helper method.)
See Also
For objects in which you can set the SymbolicName property (object store, class definition, and property template), the value of the SymbolicName property must begin with a letter and contain the following characters only: 'A' to 'Z', 'a' to 'z', '0' to '9', and '_' (underscore). No blanks or symbols are allowed. If you do not provide a value for the SymbolicName property, the server will generate it, based on the value of the DisplayName property, when you save the object.
For property template objects, changing the symbolic name of a property template for a string-valued
property that has been enabled for full-text indexing (IsCBREnabled property set to true
) will require re-indexing
of all objects containing that property. If you do not re-index, full-text searches on this property will fail to find any objects.
See Also
TableDefinition
object for the database table in which this ClassDefinition
or
PropertyDefinition
object resides.
See Also
TableDefinition
objects used by the object store. This collection represents all of the database
tables used by the Content Engine.
See Also
See Also
For a DynamicReferentialContainmentRelationship
or ReferentialContainmentRelationship
object, this is always a Folder
object.
For a Link
object, this can be any subclass of IndependentObject
.
See Also
AccessLevel
or
AccessRight
enumerations.
A PropertyDefinitionObject
defines object-valued properties as part of class definitions.
Its TargetAccessRequired
property specifies the access level that the
caller must be granted by the target object in order to assign it as the value of the object-valued property
being defined. To obtain the value of the TargetAccessRequired
property, call the property accessor methods on
PropertyDefinitionObject
.
See Also
DocumentClassDefinition
object that defines the target document class for this
XMLPropertyMappingScript
object. The target class indicates the specific document properties that will be
mapped to by the property-mapping script.
See Also
See Also
See Also
Note: If this is a local path, the Verity server must be located on the same machine as the Content Engine server, and there cannot be multiple Content Engine servers.
See Also
See Also
AccessPermissionDescription
objects to be used when creating a security template.
See Also
AccessPermission
objects to be used when creating a
security template.
See Also
See Also
See Also
See Also
null
if all index requests
have not yet been submitted. Note that this property does not indicate completion of the requests contained in the indexing job
(see the JobStatus
property for this information).
See Also
See Also
See Also
See Also
UpgradeAddOn
object. The list must contain one or more IDs (and will usually contain only one).
See Also
FolderSet
collection object containing the directly-contained Folder objects that are the
starting points (children of the root folder) in the container hierarchy.
See Also
See Also
The publish style templates associated with the PDF publishing event handler can optionally specify PDF security and watermark settings (stored as XML in the TransformationOptions property). The publish style templates associated with the HTML publishing event handler do not specify any settings in the TransformationOptions property.
See Also
URICR
. For other component relationship types, you designate the child component
by setting the ChildComponent
property. If the ComponentRelationshipType property is set to anything other than URICR
, the value of the URIValue
property is null
. Any String
value can be entered into this property; the value does not have to be a valid URI address.
See Also
ClassDefinitionSet
object representing the classes that have a property
constructed from this property template.
See Also
See Also
See Also
UserName
belongs. The values of the UserDomain
,
UserName
, and UserPassword
properties are used to login to Verity for indexing and search operations.
See Also
UserName
belongs. Only members of this
group are allowed to add to, modify, or read the Verity collection.
See Also
UserGroup
. The values of the UserDomain
,
UserName
, and UserPassword
properties are used by Content Engine servers to log in to Verity
for indexing and search operations.
See Also
samAccountName
uid
cn
cn
See Also
UserName
. The values of the
UserDomain
, UserName
, and UserPassword
properties are used by Content
Engine servers to log in to Verity for indexing and search operations.
This value is encrypted (a byte array).
See Also
(&(objectClass=user_defined_class)(an_attribute={0}))
, where
user_defined_class is the object class you want (for example, user or person) and an_attribute
is the LDAP server-specific attribute (for example, samAccountName, cn, or uid).
The default value of this property is unique to the directory service provider, as follows:
See Also
See Also
For more information about this cache, see Security Caching.
See Also
For more information about this cache, see Security Caching.
See Also
See Also
See Also
User
objects belonging to a given realm.
See Also
false
) or
as a long string (true
).
Long-string table columns store their values separately from the rest of the table and therefore bypass table row-size limitations. To avoid a table's row-size limitation being exceeded, you should use a long-string column to store a large string-valued property if the database table in which it is stored has many custom properties. Because the actual text data for a long-string column is stored separately from the rest of the database row data (requiring an additional read operation to retrieve the data) you might experience a slight decrease in performance. However you might also potentially experience a system performance gain, because the overall row size for each object is reduced when long-string columns are used, therefore decreasing fetch and storage times.
Note that, unlike short-string columns, long-string columns cannot be specified in a database index.
For database-specific information about short-string and long-string table columns, table columns, see Database Engine Differences.
See Also
filenet.vw.api.VWSession
interface's transfer method).
See Also
See Also
See Also
VerityMasterAdminServerHostname
. This is the list of brokers returned from Verity.
See Also
VerityCollection
objects associated with this index area. Each Verity collection is a
member of only one index area.
See Also
See Also
VerityMasterAdminServerHostname
property. This list of index servers is returned by Verity.
See Also
See Also
VerityMasterAdminServerHostname
.
See Also
VerityMasterAdminServerHostname
property. This list of index servers is returned by Verity.
See Also
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.See Also
VersionSeries
object that contains all of the document versions associated with this
document or DynamicReferentialContainmentRelationship
object.
See Also
Document
or its subclass.
See Also
VersionStatus
constant that indicates the current version status of this document version.
The VersionStatus property can have one of the values in the following table.
Name | Value | Description |
---|---|---|
IN_PROCESS |
2 | Indicates an in-process document version. An in-process version is a version that
has been checked in and is the latest minor version. Note that only one version at a time in a given
version series can be in the IN_PROCESS state. When a reservation version is checked in as a minor
version and becomes the new in-process version, the previous in-process version becomes a superseded version. |
RELEASED |
1 | Indicates a released document version. A released version is a version that has been
checked in and is the latest major version. Note that only one version at a time in a given version series can be in
the RELEASED state. |
RESERVATION |
3 | Indicates a reservation document version. A reservation version is a version that has been checked out. |
SUPERSEDED |
4 | Indicates a superseded document version. A superseded version is a major or minor version that has been replaced by a later version. |
See Also
VersionableSet
object that contains all of the document versions associated with
this document or version series.
See Also
See Also
VirtualServer
objects for a given site.
See Also
See Also
See Also
See Also
SubscriptionSet
collection containing the workflow subscription
(InstanceWorkflowSubscription
and/or ClassWorkflowSubscription
) objects
associated with a workflow definition.
See Also
See Also
XMLPropertyMappingScript
object applies.
The value of this property can be one of the following:
See Also
XMLPropertyMappingScriptSet
object containing the collection of XMLPropertyMappingScript
objects associated with this object store or DocumentClassDefinition
object. Each XMLPropertyMappingScript
object holds a property-mapping XSL script that is registered for XML documents of a specific type. This script extracts content
from XML documents and maps it to property values associated with a particular document class.
For DocumentClassDefinition
objects, this property specifies the set of XMLPropertyMappingScript
objects that
have specified this DocumentClassDefinition
object as the value of their TargetClass property.
See Also