The IInstanceWorkflowSubscription type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | ActiveMarkings |
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.
(Inherited from IActionConsumer.) |
![]() | AuditedEvents |
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
(Inherited from IActionConsumer.) |
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | Creator |
Indicates the name of the user assigned as the creator of the object.
(Inherited from IActionConsumer.)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. |
![]() | DateCreated |
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.
(Inherited from IActionConsumer.)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. |
![]() | DateLastModified |
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.
(Inherited from IActionConsumer.)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). |
![]() | DescriptiveText |
User-readable text that describes an object.
(Inherited from IActionConsumer.)The text is not locale-specific to the retrieving user except for the following classes:
|
![]() | DisplayName |
The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.
(Inherited from IActionConsumer.)For ICmAuditProcessingBookmark and IAuditDefinition objects, this property is intended to identify client applications that process the audit log. For ICmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object. For IAuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality. For ICmAuditProcessingBookmark and IAuditDefinition 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 ICmAuditProcessingBookmark or IAuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness. |
![]() | EnableManualLaunch |
Indicates whether the workflow for subscription object can be launched
manually (true) or not (false).
|
![]() | EventAction |
The event action object that defines the actions to be taken when a event occurs
that is subscribed to by a 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.
(Inherited from ISubscription.)Once this property is set, the Content Engine adds the Subscription-based object to the EventAction object's Subscriptions collection property. |
![]() | ExternalReplicaIdentities |
Specifies an ExternalIdentityList collection of the read-only ExternalIdentity objects
that represent the identities of replicas of this object in external repositories.
(Inherited from IReplicable.) |
![]() | FilteredPropertyId |
The symbolic name of a singleton, object-valued property defined on the source object for use in evaluation by the
filter expression. (The filter expression is defined by the FilterExpression property.)
For example, an event on a IReferentialContainmentRelationship can specify Head in the FilterPropertyId
property to have the containable object -- rather than the IReferentialContainmentRelationship -- used for filtering.
(Inherited from ISubscription.)The use of a filter expression is optional. If FilteredPropertyId is null, the source object itself is evaluated by the filter expression. NOTE For IPublishRequestEvent, apply the filter expression on the InputDocument property of the IPublishRequest object, not on an object-valued property of the source object being published. When you publish a document, a IPublishRequest object is created, which, at runtime, is the source object on which IPublishRequestEvent is triggered. |
![]() | FilterExpression |
The text of a filter expression that, when evaluated, determines the action to be taken on the object.
This property applies to IStoragePolicy, ISubscription, IAuditDefinition,
ICmSweepPolicy, and ICmSweepJob objects.
(Inherited from ISubscription.)For a IStoragePolicy 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 more information, see Storage policies. For a ISubscription-based object, FilterExpression is used to determine whether the event action should be launched. For IAuditDefinition, FilterExpression is used to determine whether an event should be audited. The filter is applied to either the source object, or optionally, to the object specified in the FilteredPropertyId property of ISubscription or IAuditDefinition. Note that for version series subscriptions, the filter is applied to the document version in the transaction and not to the version series. For ISubscription, the Content Engine server evaluates the filter expression, as follows:
For a sweep job or sweep policy, FilterExpression is used to evaluate each instance of of the sweep-target class. If the value of the expression evaluates to true, an operation is applied to the instance. The operation performed depends on the type of sweep. For IAuditDefinition objects, FilterExpression is only applicable to events of type IObjectChangeEvent. If the value of the expression evaluates to true, the event is audited; otherwise, it is not audited. The syntax of this property must be a fragment of a SQL where-clause expression (for example, VersionStatus = 1) and use supported operators. See SQL Syntax Reference. Note that some operators that are valid in an ad hoc SQL query are not supported in FilterExpression. The following operators are not supported.
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' For ISubscription and IAuditDefinition objects only, you can use the IsModified predicate, for filtering events based on modified properties of the source object. A filter expression using the IsModified predicate must be constructed as follows: IsModified(property), where property can be in any form supported elsewhere in the query, for example, table_alias.property_alias. Note that the IsModified predicate can only be used in a filter expression. It cannot be used in an ad hoc SQL query. |
![]() | Id |
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}.
(Inherited from IActionConsumer.)For IUser and IGroup 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, IUser.Id and IGroup.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. |
![]() | IsEnabled |
Indicates whether a given object is enabled or disabled. For example, you can globally disable or enable active
events by setting an IEventAction object's IsEnabled property to False (off) or True (on).
Likewise, you can enable or disable a subscription, a security template, an audit definition, an audit disposition policy,
a change preprocessor definition, a change preprocessor action, and a sweep The property defaults to true.
(Inherited from ISubscription.)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 IEventAction, all of its associated subscriptions are also disabled. However, when you disable one particular ISubscription, you only disable events that are in its subscribed event list. Disabling a change preprocessor action has system scope, that is, it prevents code handler execution for all class definitions that reference the change preprocessor action. On the other hand, disabling a change preprocessor definition has class scope; it prevents code handler execution for only that class definition, and for any subclass definitions to which the changed property value is propagated. |
![]() | IsolatedRegionNumber |
The ID number identifying this isolated region.
If multiple isolated regions are associated with the same object store (as set on the ObjectStore property), then the isolated regions will share the same database connection as the object store. For the server to distinguish between isolated regions in the same database using the same database schema name, this property must be set to a unique value for each isolated region. A unique value is not required if the isolated region will not share a database connection with other isolated regions using the same database schema name. |
![]() | IsSynchronous |
The method by which the event procedure code is executed for a ISubscription-based object(IClassSubscription,
IClassWorkflowSubscription, IInstanceSubscription, IInstanceWorkflowSubscription).
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.
(Inherited from ISubscription.)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. |
![]() | LastModifier |
Indicates the name of the user who last modified the object.
(Inherited from IActionConsumer.)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). |
![]() | Name |
The name for this object.
(Inherited from IActionConsumer.)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. |
![]() | Owner |
Manages the security owner assigned to the object.
(Inherited from IActionConsumer.) |
![]() | Permissions |
Manages the discretionary permissions assigned to the object.
(Inherited from IActionConsumer.) |
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) |
![]() | PropertyMap |
A String holding a list of mappings between the properties of a versionable-related object
and workflow data fields.
For example, you might want to map a document's Creator property with Employee Name, if that data
field exists in the workflow definition. The workflow data fields you specify in the property map
must be designated as launch step parameters in the workflow definition.
|
![]() | ReplicationGroup |
A ReplicationGroup object representing the replication group to
which this replicable object belongs.
(Inherited from IReplicable.)For ReplicationJournalEntry objects only, this property represents the replication group to which the source object of the replication operation generating this journal entry belongs. |
![]() | Subject |
The suggested subject prefix for the workflow subscription.
|
![]() | SubscribedEvents |
A list of objects specifying the events to which the subscription applies.
When you create a subscription, you set this property to ISubscribedEventList,
a list of objects representing the system and custom events to which to subscribe.
(Inherited from ISubscription.) |
![]() | SubscriptionTarget |
The target object of a ISubscription-based object(IClassSubscription,
IClassWorkflowSubscription, IInstanceSubscription, IInstanceWorkflowSubscription).
You set the property with a Subscribable object, then specify the property when you create
the ISubscription-based object.
(Inherited from ISubscription.)For a IClassSubscription or IClassWorkflowSubscription object, set the value of the SubscriptionTarget property to a ISubscribableClassDefinition 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 moreof the IEventAction object's events to be raised. For an IInstanceSubscription or IInstanceWorkflowSubscription object, set the value of the SubscriptionTarget property to a specific ISubscribable object. This means that only this currently instantiated object, when acted upon, causes one or more of the IEventAction object's events to be raised. If the object is a IVersionSeries object, the event is raised when a version in the version series is acted upon. |
![]() | UserString |
A string used to identify a subscription, with no built-in behavior.
(Inherited from ISubscription.) |
![]() | VWVersion |
A unique identifier for a compiled (transferred) workflow definition. The Process Engine assigns this
property's value after a workflow definition is transferred to the Process Engine server
(either via the Process Designer application or the filenet.vw.api.VWSession interface's transfer method).
|
![]() | WorkflowDefinition |
A WorkflowDefinition object representing the workflow definition associated with a workflow subscription.
|