Workflow Definitions

  • Article

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

A Workflow definition defines a workflow that can be applied to lists. The Workflow element contains the definition of a workflow.

Workflow
  Metadata

Workflow Attributes

Name Data Type Description

Description

Text

Specifies a localizable, longer description of the workflow.

EngineAssembly

Text

Provides the path to a strongly named assembly that contains a workflow routing engine.

EngineClass

Text

Provides a namespace-qualified type name for a class that implements a workflow routing engine. This class derives from Microsoft.SharePoint.Workflow.SPWorkflowEngine.

HostServiceAssembly

Text

Provides the path to a strongly named assembly that contains the services that wrap a workflow engine.

HostServiceClass

Text

Provides a namespace-qualified type name that implements a services provider for this workflow. This class derives from Microsoft.SharePoint.Workflow.SPWorkflowHostService.

Name

Text

The name attribute specifies a localizable title for the workflow.

TemplateBaseId

Guid

Provides the base unique identifier for the template.

WorkflowAssembly

Text

Provides the path to a strongly named assembly which contains a workflow implementation.

WorkflowClass

Text

Provides a namespace qualified type name which implements this workflow.

MetaData Element

The MetaData element specifies arbitrary metadata that is packaged with the workflow template. This metadata is the starting state of the workflow, and it can be read and modified through the association form, the initiation form, and the workflow engine.

The format of the MetaData section is a set of named tags with values specified as inner contents. The following example creates a property named Instantiation_FormURN with the value "test.urn":

<MetaData>
   <Instantiation_FormURN>test.urn</Instantiation_FormURN>
</MetaData>

Example

The following example shows the contents of an XML file that defines a Workflow feature.

<Elements xmlns="https://schemas.microsoft.com/sharepoint/">
   <Workflow Name="Moderation" Description="A standard WSS Moderation Workflow" TemplateBaseId="681127D0-0919-416a-945B-05F1643C07E2" 
      WorkflowClass="Microsoft.SharePoint.Workflow.SPModerationWorkflow" 
      WorkflowAssembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=94de0004b6e3fcc5" 
      CodeBesideClass="Unused" CodeBesideAssembly="Unused"      HostServiceClass="Microsoft.SharePoint.Workflow.SPModerationHostServices" 
      HostServiceAssembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=94de0004b6e3fcc5" 
      EngineClass="Microsoft.SharePoint.Workflow.SPModerationEngine" 
      EngineAssembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=94de0004b6e3fcc5" > 
      <Metadata /> 
   </Workflow>
</Elements>

For information about workflows and how they function within Windows SharePoint Services, see Workflows in Windows SharePoint Services.