Represents a subscription that initiates a workflow in response to events generated by all objects of a particular class. A IClassWorkflowSubscription object provides object properties to link a workflow (IWorkflowDefinition), a target object, and one or more events (ISubscribedEvent) that can be triggered on the target object. These objects must exist before you can create a IClassWorkflowSubscription object and persist it.

To create a IClassWorkflowSubscription object, call the createInstance method on the Factory.ClassWorkflowSubscription class.

You can instantiate a persisted IClassWorkflowSubscription object in the following ways:

  • By calling the GetInstance or FetchInstance method on the Factory.ClassWorkflowSubscription class.
  • By instantiating a ISubscriptionSet collection, then returning a IClassWorkflowSubscription object from the collection.
  • By getting the WorkflowSubscriptions property on an IClassDefinition object, then iterating the IClassWorkflowSubscriptionSet collection.

The following tables list the members exposed by IClassWorkflowSubscription.

Public Properties

 NameDescription
Public propertyEnableManualLaunchIndicates whether the workflow for subscription object can be launched manually (true) or not (false).
Public propertyIsolatedRegionNumberThe unique ID number identifying this isolated region.
Public propertyPropertyMapA 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.
Public propertySubjectThe suggested subject prefix for the workflow subscription.
Public propertyVWVersionA 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).
Public propertyWorkflowDefinitionA WorkflowDefinition object representing the workflow definition associated with a workflow subscription.
Top

See Also