This topic alphabetically lists the properties that apply to the ClassSubscription class.
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.
AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ActiveMarking
RequiresUniqueElements: true
Settability: READ_ONLY
TargetAccessRequired: READ
EventSet
collection of the Event
objects containing the audited events that have occurred for the
object.
AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: Event
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
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.
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
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.
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
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).
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_WRITE
TargetAccessRequired: READ
The text is not locale-specific to the retrieving user except for the following classes:
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: 255
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
MaximumLengthString: 64
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
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.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: Subscriptions
RequiredClass: EventAction
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: LINK
ExternalIdentityList
collection of the ExternalIdentity
objects representing the
identities of replicas of this object in external repositories.
AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: ExternalIdentity
RequiresUniqueElements: true
Settability: READ_WRITE
TargetAccessRequired: READ
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:
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: false
IsOrderable: false
IsSearchable: true
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
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.)
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: 64
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
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.
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
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: BOOLEAN
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: true
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
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.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: BOOLEAN
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: true
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
Subscription
-based object
(ClassSubscription
, ClassWorkflowSubscription
, InstanceSubscription
, InstanceWorkflowSubscription
).
To execute the event procedure synchronously, set the property to true
.
To execute the event procedure asynchronously (in the background), set the property to false
.
The default is false
.
Specify the property when you create the Subscription
-based object.
When an asynchronous event procedure is triggered, the action occurs on a separate execution thread, allowing the subscription processor to continue without waiting for the results of the action. The Content Engine inserts the event into the QueueItem table, after any other waiting asynchronous operations, and executes it when resources permit. While execution usually occurs instantaneously, there might be a delay if many other asynchronous events or operations (such as security propagation or XML classification) are waiting in the queue. If your application depends on a particular asynchronous event procedure being completed, your application should first test the status of that event to verify its completion.
If the asynchronous event action fails, the exception comes back to the server. The event action transaction rolls back, but the transaction of the originating activity executes.
Note that for domains in which there are multiple Content Engine server instances, any server in the domain can handle a queued asynchronous event, not just the server that generated the event.
When a synchronous event procedure is triggered, the call to execute the event action blocks further processing by the subscription processor until the action completes. The action runs in the same transaction as the originating activity on the target object. If the action fails, the exception comes back to the client. The single transaction rolls back; therefore, the originating activity fails along with the event action.
Note that, for a workflow subscription, this property is read-only with a value of false
because a workflow subscription's event is always fired asynchronously on Content Engine.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: BOOLEAN
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
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).
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_WRITE
TargetAccessRequired: READ
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.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE_OWNER
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE_ACL
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: DiscretionaryPermission
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 50
PropertyMaximumInteger32: 100
PropertyMinimumInteger32: 1
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
ReplicationGroup
object representing the replication group to
which this replicable object belongs.
AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE_ACL
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: ReplicationGroup
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
SubscribedEventList
collection,
a list of objects representing the system and custom events to which to subscribe.
AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: SubscribedEvent
RequiresUniqueElements: true
Settability: READ_WRITE
TargetAccessRequired: READ
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.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: SubscribableClassDefinition
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: LINK
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: ClassSubscription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: 250
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ