Represents a workflow definition, an XML document of class "WorkflowDefinition" that is stored in a Content Engine object store. A workflow definition describes the instructions, paths, and queues available to a workflow, and acts as a processing template that the Process Engine uses each time the workflow runs. Workflow definition documents are versionable, containable, and can have a lifecycle associated with them.

The IWorkflowDefinition interface extends the IDocument interface, and can, therefore, be treated as a Document object. For example, a WorkflowDefinition object can have workflows linked to it. Therefore, a user selecting a workflow definition can either launch it, or launch a linked workflow.

To create a new WorkflowDefinition object and persist it to a Content Engine object store, call the CreateInstance method on the Factory.WorkflowDefinition class.

After you create a workflow definition, you link it to an object that implements the Subscribable interface by setting the SubscriptionTarget and WorkflowDefinition properties on a workflow subscription object (InstanceWorkflowSubscription or ClassWorkflowSubscription object). Note that you cannot delete a WorkflowDefinition object if a workflow subscription object refers to it in its WorkflowDefinition property.

To return all of the workflow subscription objects associated with this WorkflowDefinition object, retrieve the WorkflowSourceSubscriptions property.

You can instantiate a WorkflowDefinition object in the following ways:

  • By calling the GetInstance or FetchInstance method on the Factory.WorkflowDefinition class.
  • By retrieving the WorkflowDefinition property on a workflow subscription object.
  • By instantiating a WorkflowDefinitionSet collection, then returning a WorkflowDefinition object from the collection.

Namespace:  FileNet.Api.Core
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Public Interface IWorkflowDefinition _
	Implements IDocument, IRepositoryObject, IVersionable, IContainable,  _
	ICmHoldable, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject,  _
	IEngineObject, ICloneable
C#
public interface IWorkflowDefinition : IDocument, 
	IRepositoryObject, IVersionable, IContainable, ICmHoldable, IReplicable, 
	ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable
Visual C++
public interface class IWorkflowDefinition : IDocument, 
	IRepositoryObject, IVersionable, IContainable, ICmHoldable, IReplicable, 
	ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable
JavaScript
FileNet.Api.Core.IWorkflowDefinition = function();
FileNet.Api.Core.IWorkflowDefinition.createInterface('FileNet.Api.Core.IWorkflowDefinition');

ToggleRemarks

Metadata

Auditable: undefined
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: DocumentClassDefinition
IsDependent: false
IsHidden: true
Searchable: true
StorageType: ObjectStore
SuperclassName: Document

ToggleSee Also