DocumentClassificationAction Properties

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

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

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

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

See Creating a CodeModule Object.

Indicates the name of the user assigned as the creator of the object.

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

Indicates the date and time the object was created. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

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

Indicates the date and time the object was last modified. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

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

User-readable text that describes an object.

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

• ClassDescription
• PropertyDescription
• ClassDefinition
• PropertyTemplate
• PropertyDefinition

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

For CmAuditProcessingBookmark and AuditDefinition objects, this property is intended to identify client applications that process the audit log. For CmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object. For AuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality.

For CmAuditProcessingBookmark and AuditDefinition objects, it is recommended that you set this property. Specify a unique value to distinguish one client application from another. Note, however, that the server does not prevent identical display names across multiple CmAuditProcessingBookmark or AuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness.

Specifies an ExternalIdentityList collection of the read-only ExternalIdentity objects that represent the identities of replicas of this object in external repositories.

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

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

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

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

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

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

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

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

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

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

Each content element that is attached to a document or annotation has its own MIME type, which is specified by its ContentType property. If you do not specify the MimeType property for a document or annotation, it is automatically set by the Content Platform Engine to the value of the first content element, regardless of whether it is a ContentTransfer or ContentReference object.

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

MIME defines the following content types:

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

The following MIME types are specific to FileNet:

• application/x-filenet-declarerecordtemplate: Record template.
• application/x-filenet-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.

The name for this object.

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

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

Manages the security owner assigned to the object.

Manages the discretionary permissions assigned to the object.

Specifies the action handler to execute when an Action-based object is invoked.

For a JavaScript handler that's set on the ScriptText property, set this property to "Javascript".

For a Java™ handler, specify the fully qualified name of the Java class that executes.

For a WorkflowEventAction object, the ProgId must be set to the system-supplied handler, filenet.pe.ce.wfeventhandler.WorkflowEventActionHandler.

Specifies a ReplicationGroup object representing the replication group to which this replicable object belongs. For ReplicationJournalEntry objects only, this property represents the replication group to which the source object of the replication operation generating this journal entry belongs.

The script text that's executed when an Action-based object is invoked.

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