CmEventExportStore Properties

This topic alphabetically lists the properties that apply to the CmEventExportStore class.

ClassDescription Property



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

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Creator Property



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.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: 80
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: SETTABLE_ONLY_ON_CREATE
TargetAccessRequired: READ

DatabaseConnection Property



Defines the database connection attributes used by this object. Set this property to a CmDatabaseConnection object, which defines the data sources to be used by the object. For database connection sharing, set the same CmDatabaseConnection object on all object stores, event export stores, and isolated regions that will share the same database.

For an isolated region, if the ObjectStore property is set, then the server automatically sets this property and the DatabaseSchemaName property to the same values as the object store's properties of the same name. You cannot change the object store-derived values on this or the DatabaseSchemaName property.

If the isolated region is used by IBM Case Manager, you must set the ObjectStore property. For an isolated region that uses a legacy workflow system, set DatabaseConnection and DatabaseSchemaName to values that reference the legacy system.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: CmDatabaseConnection
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

DatabaseSchemaName Property



Specifies the name of the schema in which the tables and indexes for an object store, isolated region, or event export store reside. The value serves as a qualified name for the database entities.

A unique value is required for database connection sharing. Database connection sharing is initiated when two or more objects are configured to use the same CmDatabaseConnection object.

To distinguish between identically named tables associated with multiple objects that share a database connection, enter a unique, case-insensitive value. The value cannot duplicate the DatabaseSchemaName value of another object using the same database connection. The value will be prepended to database entities, for example, <schema name>.<table name>.

If you do not set a value for an object store, the object store is initialized using the default schema applied by the database server, and this property is set to that default schema name provided it is not already in use by another object store using the same CmDatabaseConnection object.

For an isolated region, if the ObjectStore property is set, then the server automatically sets this property and the DatabaseConnection property to the same values as the object store's properties of the same name. You cannot change the object store-derived values on this or the DatabaseConnection property.

If the isolated region is used by IBM Case Manager, you must set the ObjectStore property. For an isolated region that uses a legacy workflow system, set DatabaseConnection and DatabaseSchemaName to values that reference the legacy system.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
MaximumLengthString: 128
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

DateCreated Property



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.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: SETTABLE_ONLY_ON_CREATE
TargetAccessRequired: READ

DateLastModified Property



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

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

DescriptiveText Property



User-readable text that describes an object.

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

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: 255
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

DisplayName Property



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.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
MaximumLengthString: 64
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

ExporterType Property



The type of event export store to create for Case Analyzer, Case History, or Process Simulator. The property takes a value of EventExporterType.

In IBM Content Foundation, Case Analyzer and Process Simulator are not supported.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 2
PropertyMaximumInteger32: 3
PropertyMinimumInteger32: 1
RequiresUniqueElements: false
Settability: SETTABLE_ONLY_ON_CREATE
TargetAccessRequired: READ

Id Property



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

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

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

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

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: GUID
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

LastModifier Property



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

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: 80
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

SourceDatabaseConnection Property



The database connection identifying the Content Engine object store and workflow system from which events are exported.

If the SourceObjectStore property is set, then the server automatically sets this property and the SourceDatabaseSchemaName property to the same values as the object store's properties of the same name. You cannot change the object store-derived values on this or the SourceDatabaseSchemaName property.

For Case History, you must set the SourceObjectStore property. To use a legacy workflow system with Case Analyzer, then set SourceDatabaseConnection and the SourceDatabaseSchemaName properties to values that reference the legacy system.

In IBM Content Foundation, Case Analyzer is not supported.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: CmDatabaseConnection
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

SourceDatabaseSchemaName Property



The name of the schema identifying the Content Engine object store from which events are exported.

If the SourceObjectStore property is set, then the server automatically sets this property and the SourceDatabaseConnection property to the same values as the object store's properties of the same name. You cannot change the object store-derived values on this or the SourceDatabaseConnection property.

For Case History, you must set the SourceObjectStore property. To use a legacy workflow system with Case Analyzer, then set SourceDatabaseConnection and the SourceDatabaseSchemaName properties to values that reference the legacy system.

In IBM Content Foundation, Case Analyzer is not supported.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: 128
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

SourceObjectStore Property



The object store from which events are exported for either Case Analyzer or Case History publishing service. In IBM Content Foundation, Case Analyzer is not supported.

If you set this property, the server automatically sets the SourceDatabaseConnection and SourceDatabaseSchemaName properties to the same values as the object store's properties of the same name, even if SourceDatabaseConnection and SourceDatabaseSchemaName were previously set to different values. Once set, this property cannot be modified.

For Case History, you must set the SourceObjectStore property.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: DocSpace
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ