Public Properties

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

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

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

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

Public property ClassificationStatus Specifies a DocClassificationStatus constant that indicates the auto-classification status for this document. The ClassificationStatus property is used to provide client applications a means of discovering whether a particular

document is subject to auto-classification, and if so, whether or not the operation was successful. This property can hold one of the following values:

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

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

Valid settings are:

  • COMPOUND_DOCUMENT: Designates the document as the parent component in a compound document. Initially, this parent document has no child components. A document must be designated as a compound document to become a parent component for a ComponentRelationship object.
  • STANDARD_DOCUMENT(default setting - 4.0.x release): Designates the document as a standard document. This setting prevents the document from being a parent component within a compound document. A document cannot be designated as a standard document when referenced as a parent component by a ComponentRelationship object.
  • null (default setting - 3.5.x upgraded to 4.0.x): Designates the document as a standard document. By default, pre-existing documents in an object store upgraded to 4.0.x return a null value instead of STANDARD_DOCUMENT. Note that, although a null value can be returned, you cannot set this property to null.
Public property ContentElements Specifies a ContentElementList object containing the list of content elements associated with this document or annotation. Each content element represents content data, which can either be local to an object store and stored in a file store or database (represented by a ContentTransfer object) or external to an object store and therefore outside the control of the Content Engine server (represented by a ContentReference object).
Public property ContentElementsPresent Specifies a StringList object containing the MIME type of each content element
Public property ContentRetentionDate Specifies the date until which this checked-in document must be retained, as determined by the content storage subsystem. This document can be deleted only after this date has passed.
Public property ContentSize Specifies the size in bytes of the content data associated with this document, annotation, or ContentTransfer object. Note that if the document or annotation has more than one content element, then the size is the sum of all of the content elements.
Public property CurrentState Specifies the name of the current lifecycle state of this document as defined by its document lifecycle policy. Each document lifecycle policy defines a set of states through which a StateName property of the DocumentState object representing the document can transition into during its lifecycle. This property is equal to the value of the current lifecycle state of this document.
Public property DateContentLastAccessed Specifies the date and time when the content data (represented by a ContentTransfer object) associated with this document or annotation was last accessed. The Content Engine stores dates and times using Coordinated Universal Time (UTC). The recording granularity of the date and time returned by this property is determined by the setting of the object store's ContentAccessRecordingLevel property. The content data associated with a document or annotation object is considered to be accessed when one of the following events occur:
  • An object's Refresh method is called with the property filter set to refresh PropertyContent properties (FilteredPropertyType.CONTENT_DATA).
  • An object's AccessContentStream method is called to retrieve content data in an input stream.
Each of these events will update the date of the DateContentLastAccessed property. Note that even if the content data is larger than the user-specified chunk size and multiple trips to the database or cache are required, the DateContentLastAccessed property will be set only to the date and time that the content data was first accessed. Applications that access content data frequently will cause continual updates of the DateContentLastAccessed property by the server, which can result in degraded performance. Therefore, it is recommended that you set the ContentAccessRecordingLevel property to control the frequency that the DateContentLastAccessed property is updated.
Public property DependentDocuments Specifies a DocumentSet collection object that contains all of the publication documents to which this document is the owner document.
Public property DestinationDocuments Specifies documents that are publications of this document. This property is a reflective property of the SourceDocument property.
Public property DocumentLifecyclePolicy Specifies the DocumentLifecyclePolicy object that represents the lifecycle policy that has been applied to this document. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken when a document's lifecycle state changes.
Public property IndexationId The object ID (GUID) of the Verity collection used. This will be null for objects that were full text indexed prior to the 4.0 release.

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

Public property IsInExceptionState Specifies whether the lifecycle state of this document is in an exception state (true) or not (false). As long as a document is in an exception state, its lifecycle state can neither be promoted nor demoted. To clear a document from an exception state, you must call its ChangeState method and set the LifecycleChangeFlags parameter to CLEAR_EXCEPTION.
Public property MimeType Specifies the Multipurpose Internet Mail Extensions (MIME) format string of the content data carried by this document, annotation, or document classification action.

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

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

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

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

  • If the object contains one or more ContentTransfer objects that all have the same value for their ContentType property, MimeType is set to the value of the ContentType property.
  • If the object contains a single ContentReference object, MimeType is set to "application/x-filenet-external".
  • If the object contains multiple ContentReference objects (but no ContentTransfer objects), MimeType is set to "multipart/x-filenet-external".
  • Otherwise, MimeType is set to "multipart/mixed".

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 format: "MIME::content type/subtype[;parameter]". For example: "MIME::text/html". MIME defines the following content types:

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

The following MIME types are specific to FileNet:

  • application/x-filenet-declarerecordtemplate: Record template.
  • application/x-filenet-documentassembly: Document assembly.
  • application/x-filenet-external: An object that contains a single ContentReference content element.
  • application/x-filenet-external-is: External Image Services document.
  • application/x-filenet-publishtemplate: Publish template.
  • application/x-filenet-scenariodefinition: Scenario definition document.
  • application/x-filenet-search: Stored search.
  • application/x-filenet-searchtemplate: Search template.
  • application/x-filenet-workflowdefinition: Workflow definition document.
  • multipart/x-filenet-external: An object that contains multiple ContentReference content elements only.
Public property OwnerDocument For a published document, contains a reference to the Document object representing the owner document associated with the published document. If this document is a publication and there is a cascade delete relationship with the source, then this property will specify the publication source document (the OwnerDocument and PublicationSource properties will reference the same document).
Public property ParentDocuments A DocumentSet collection object that contains the parent Document objects bound to this child document. The collection contains only those parent documents for which the user has read access. For each ComponentRelationship object that references this document as the child component document, the collection contains the parent component document. The same parent document can be in the collection more than once.
Public property ParentRelationships A ComponentRelationshipSet collection object that contains the ComponentRelationship objects referencing this document as the child component document. The collection contains only those parent relationship objects for which the user has read access.
Public property PublicationInfo Specifies the parameters (formatted as XML) that were used to publish a document. The parameters, which are used to republish the document, include the original output folder ID, style template ID, publish template ID, and publish template version series ID. For example:
 Copy Code
             <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.

Public property PublishingSubsidiaryFolder Specifies a folder which contains the subsidiary documents of an HTML publication (for example, image, audio, and style sheet files).
Public property ReleasedVersion Specifies a document version that represents the latest released version associated with this document or version series. A released version is a major version that has a VersionStatus property value of RELEASED. Note that only one document version at a time in a given version series can be in the released state.
Public property SecurityParent Obsolete. Specifies the object from which a given object inherits security. The value of this property is a ReferentialContainmentRelationship (or DynamicReferentialContainmentRelationship) that represents the object from which security is inherited.

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

Public property SourceDocument Specifies the source document for a published document.
Public property StorageArea Specifies the storage area for a content-carrying object.
Public property StorageLocation Specifies the storage location for an object's content. This property is deprecated in FileNet P8 4.0 and is only set in upgraded object stores. It has been replaced by the StorageArea property.
Public property StoragePolicy Specifies the document's storage policy, which identifies the set of available storage areas that are considered equivalent based on common, user-specified criteria. Assigning a storage policy to a document is the recommended method of selecting a storage area. The alternative is to directly assign the storage area (specify the StorageArea property).

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

  • instance value for the StorageArea property
  • class default for the StorageArea property
  • instance value for the StoragePolicy property
  • class default for the StoragePolicy property

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.

Public property WorkflowSubscriptions The IInstanceWorkflowSubscriptionSet object containing the IInstanceWorkflowSubscription objects whose target is this object.
Top

See Also